docs: Standardize via CONTRIBUTING.md + WRITING.md - #99
Merged
Conversation
why: AGENTS.md is read on every task, so a policy that matters to one
class of change costs context on all the others. Splitting how we work
from how we write lets each be loaded when it applies, and keeps both
discoverable to humans rather than only to agents.
what:
- Replace AGENTS.md body with a router: the project map, universal
change discipline, then one pointer per class of change
- Add .github/WRITING.md, the fullest "Documented examples that run"
section in the fleet: both collection paths (.py delegates to
pytest's own DoctestModule; .rst/.md go through
DocutilsDocTestFinder), every directive form (doctest_block,
.. doctest::/{doctest}, testsetup/testcleanup), and what each
registered flag (ALLOW_UNICODE, ALLOW_BYTES, NUMBER, HIDE) actually
does versus the stdlib set
- Document, verified against source and tests, that testsetup/
testcleanup do not share globals across blocks the way Sphinx's own
testsetup does, and that docs/justfile's doctest recipe is not run
by CI
- Add .github/CONTRIBUTING.md with this repo's real gates, matrix, and
release process, read from pyproject.toml, the justfile, and the
workflows
- Fix README: unverified PyPy support claim, docutils/myst-parser
minimum-requirements section against actual pyproject.toml pins, a
typo naming the package, and a "We"-voiced sentence; preserve every
link and all three `>>> ` prompts
- Replace docs/project/contributing.md and code-style.md with pointer
pages to the canonical files; an {include} was tried and produces
dead cross-file anchors on this repo's Sphinx, confirmed by
inspecting the built HTML
- Delete docs/AGENTS.md and docs/CLAUDE.md (absorbed into WRITING.md)
and the lowercase .github/contributing.md (replaced)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #99 +/- ##
==========================================
- Coverage 76.68% 76.63% -0.05%
==========================================
Files 15 15
Lines 1025 1023 -2
==========================================
- Hits 786 784 -2
Misses 239 239 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tony
changed the title
CONTRIBUTING.md + WRITING.md
why: iter_documentation_markdown_files walks README.md and docs/**, and this branch removes docs/AGENTS.md and docs/CLAUDE.md, so the name guard can no longer match anything. Code nothing can reach is the kind this project's own writing guide says to delete. what: - Remove the AGENTS.md/CLAUDE.md skip from the documentation walk
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.
AGENTS.mdis read on every task, so a policy that matters to one class of change costs context on all the others. This splits how the project works from how it writes, so each loads when it applies, and makes both discoverable to humans rather than only to agents.The root file becomes a router. It carries what should always be visible — what the repository is, where things live, and the change discipline every diff is held to — then points at one document per class of change.
Layout
What moved
Nothing was deleted without a destination. Environment, commands, gates, testing strategy and fixtures moved to
.github/CONTRIBUTING.md. Docstring conventions, doctest rules, changelog conventions, code-block rules, the comment gates and slop prevention moved to.github/WRITING.md, along with the whole ofdocs/AGENTS.md("Documentation voice"), which is prose policy and now has one home.Verification
Every gate was run, and the doctest collection count was recorded before and after. Documented examples are executed by
pytest, so a preserved example that stopped being collected would be an invisible test deletion — the count is the proof it did not happen.This repository
AGENTS.mdgoes from 751 lines to 65, across 9 changed files. No source, test, or CI file is touched.