docs: describe the source README layout - #97
Merged
Merged
Conversation
The README layout was only defined by example, and several source READMEs had grown configuration references and release notes. Write the layout down next to the rule that keeps source READMEs short. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
The source README layout (tagline, Features, Documentation, Tests, License last) was only defined by example. A repository audit found configuration references, command references, upgrade notes and release-note text added as README sections in about 15 repositories, plus stray root-level manuals. This PR writes the layout and the boundary into MAINTAINING.md, so feature PRs update Docs guides instead.
The companion source and Docs PRs from the same audit bring each repository into this layout.
Checks
python3 scripts/check-indexes.pypasses🤖 Generated with Claude Code