docs: make AGENTS.md the home of design principles and documentation rules - #260
Merged
Merged
Conversation
Move the decoupling principle, extension contracts, pre-release policy and documentation rules from CONTRIBUTING.md into AGENTS.md as protocol-first design rules: one protocol per boundary, complexity kept in adapters, one home per setting and datum, no compatibility layers, and documentation rules. CONTRIBUTING.md keeps workflow, review, checks and naming. The architecture overview keeps its boundary responsibilities and links to AGENTS.md for each protocol's code and document.
Complete the boundary table with every protocol file and the generated OpenAPI sources, list the files each adapter touches, add known gaps, correct component ownership and the storage layout, and add the no hard-wrap documentation rule. Move the remaining adapter rules out of CONTRIBUTING.md, collapse its per-boundary ownership rows into AGENTS.md, drop contradicting evidence wording and the stale AGENTS.md name-guard exception.
List one entry point per protocol boundary, point to the extension guides for adapter files, add the public API principle moved from CONTRIBUTING.md, state the storage rule with a compact category list owned in detail by docs/configuration.md, and keep known gaps as categorical examples. Move compatibility evidence rules into Required checks, repoint the ownership links in the contract and service READMEs, and drop allowlist entries for removed CONTRIBUTING.md text.
Name the authored sources of the three HTTP contracts, link the storage categories to the configuration reference, keep only the application boundary principle in the public API rules, restore the test-artifact and application-ownership lines in CONTRIBUTING.md, correct how Core reaches Harnesses in the architecture overview, and point the concepts guide and contract index to AGENTS.md instead of restating its rules.
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
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.
Part of the documentation overhaul.
Changes
AGENTS.md becomes the single home of the project's design rules and documentation rules. CONTRIBUTING.md keeps how-to-work material. Nothing is stated in both files.
docs/configuration.mdowns the layout.OPENAI_BASE_URL/OPENAI_API_KEYin examples.In CONTRIBUTING.md, the decoupling, extension-contract, pre-release, documentation-rule and design/compatibility sections moved out. Evidence rules sit under Required checks. The ownership map points protocol boundaries and design rules to AGENTS.md.
docs/architecture.mdkeeps the overview and links to the AGENTS.md boundary table.docs/design-principles.mdandcontracts/agents-api/README.mdlink to AGENTS.md instead of restating its rules. The three files this PR owns are unwrapped: one line per paragraph, rendering identical.Verification
make check-names,make check-docs,make check-distributionNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.