docs: consolidate documentation and reduce redundancy#272
Open
liujuanjuan1984 wants to merge 1 commit intomainfrom
Open
docs: consolidate documentation and reduce redundancy#272liujuanjuan1984 wants to merge 1 commit intomainfrom
liujuanjuan1984 wants to merge 1 commit intomainfrom
Conversation
- Centralize security principles in SECURITY.md. - Move technical usage and full examples to docs/guide.md. - Consolidate Git/Issue/PR workflows in CONTRIBUTING.md. - Refocus AGENTS.md on agent-specific rules and tooling. - Promote scripts/doctor.sh as the primary validation entrypoint. - Standardize project positioning across all documents.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses several documentation redundancies, inconsistencies, and positioning overlaps identified in the
opencode-a2a-serverepository.Key Changes
SECURITY.md.README.mdanddocs/guide.mdnow point toSECURITY.md.CONTRIBUTING.md. RefocusedAGENTS.mdon rules specifically for AI agents (Simplified Chinese for discussion,ghCLI usage).docs/guide.mdas the canonical source for full environment variable lists and the recommended two-process example. AddedA2A_STREAM_SSE_PING_SECONDSto the catalog.scripts/doctor.shas the primary local regression tool inCONTRIBUTING.mdandAGENTS.md.README.md.Verification
./scripts/doctor.shto ensure all linting and tests pass.Closes #xx (if there's a specific issue, user didn't provide one, but this is the standard flow)