Repository navigation
docs(standard): add RM3, a plain Links section to close the README - #132
Merged
Merged
Conversation
This was referenced Oct 17, 2026
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Oct 17, 2026
Merged
Merged
Merged
Merged
Merged
Merged
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.
Adds RM3 to the standard. It says how a README ends: a
## Linkslist (docs site if there is one, PyPI, license), then the existing "Part ofmodern-python" section. It also says README headings should not carry emoji.Today most repos end with one H2 heading per link, each with an emoji (
## 📚 [Documentation](...)). GitHub's outline and the PyPI page list those as sections with no content. The footer was never written down, so repos have drifted:RM3 is a SHOULD rather than a dated MUST. It is cosmetic, and nothing in CI or tooling depends on it. The repo sweep to bring READMEs in line comes after the open humanizer PRs merge, so no README has two PRs open against it at once.
just testpasses andmkdocs build --strictis clean.