Repository navigation
docs: slim CONTRIBUTING and make extension guides step-by-step - #228
Merged
Merged
Conversation
CONTRIBUTING keeps only repository-wide rules. Component rules move to their canonical owners (runtime-protocol, environments, harness docs, Sandbox Provider guide, maintainers, service and adapter READMEs, and the new services/agents-api/IMPLEMENTATION.md). Sandbox Provider and Harness guides become numbered start-to-finish paths with verified registration files, the five required provider operations, engine selection and the Turn cancellation owner.
Delete mcode-workspace-v1.md (historical evidence only) and startup-configuration.md (removed route), fix inbound links and drop task-board/Feishu process steps from contracts.
The Parsar/Core product boundary is a repository-wide rule; restore it under Repository boundary instead of the service implementation notes, and reword two implementation lines to current names.
…zed docs - The native direct-connection rule replaces the removed model proxy rule in services/agents-api/IMPLEMENTATION.md. - Harness onboarding gains the internal/harnessconfig entry point and the new RegisterKind signature. - User guide, Agents API guide and quickstart state each harness's supported protocols; there is no conversion. - The check-distribution note moves into the maintainer guide.
… rules to their owners
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 3 of 3 of the documentation cleanup (after #225 and #226).
CONTRIBUTING: 3786 → 385 lines
CONTRIBUTING now keeps only repository-wide rules:
Component rules moved to their owners, merged into existing sections where possible:
docs/runtime-protocol.mdcontracts/agents-api/environments.md#runtime-capability-preparationdocs/maintainers.mdservices/agents-api/IMPLEMENTATION.md(new)harness-onboarding.md/harnesses.md#acceptance-checklistdeploy/*READMEsapps/web/README.mdEvery removed block is listed with its reason. Nothing normative was dropped: blocks that might be normative were moved, not deleted.
Adding a Sandbox Provider or a Harness
docs/sandbox-provider.mdis now a numbered start-to-finish guide.Create,GetInfo,Renew,Kill,RunCommand. Old text said 4 in places.harness-onboarding.mdis the single numbered guide.harnesses.mdkeeps qualification and now has a MiniMax Code column.Cancelis on theSessionembedded by eachTurn.docs/development.mdhas one short paragraph and a link per extension boundary.Historical contracts
mcode-workspace-v1.md(marked "historical evidence only") andstartup-configuration.md(marked removed), with every inbound link fixed.Rebase notes
The branch was rebased onto main after #222, and the upstream CONTRIBUTING changes were ported to their new owners:
harness-onboarding.mddocs/maintainers.mdValidation
All of the following pass:
make check-docscheck-namescore-distribution-manifest.py docs)core-distribution-manifesttestsNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.