docs: Standardize via CONTRIBUTING.md + WRITING.md - #76
Merged
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 the AGENTS.md body with a router: the project map grouped by
the workspace's own tiers, universal change discipline, then one
pointer per class of change
- Add .github/WRITING.md for prose policy: voice, the docs/ authoring
conventions merged in from docs/AGENTS.md, the corrected doctest
mechanism (Markdown under docs/ and README.md is not collected —
only .py under testpaths is), the Django-style CHANGES convention,
docstrings, Sphinx/MyST role and {include} conventions, CSS naming,
source comments, and slop prevention
- Add .github/CONTRIBUTING.md for workflow policy: setup (including
the pnpm/Node requirement and its SPHINX_VITE_BUILDER_SKIP escape
hatch), the real CI gate commands, code style, the full test
hierarchy and fixture reference, docs build, and releasing
- Delete docs/AGENTS.md, docs/CLAUDE.md, and .github/contributing.md
(lowercase), now absorbed into the files above
- Turn docs/project/contributing.md and docs/project/code-style.md
into pointer pages at the canonical .github/ files ({include} does
not carry relative links across a directory boundary here, per the
fleet's settled finding)
- Trim packages/sphinx-vite-builder/AGENTS.md to what is package
specific, route it to the root docs, and correct two stale claims
(the Sphinx extension is not a Phase 1 placeholder; it has no
long-lived watch process) plus a stale actions/setup-node pin
- Replace the sphinx-vite-builder CLAUDE.md pointer file with a real
symlink to AGENTS.md, matching the root
- Add the alpha warning to README.md and reflow it to 80 columns
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #76 +/- ##
=======================================
Coverage 92.94% 92.94%
=======================================
Files 276 276
Lines 22753 22753
=======================================
Hits 21148 21148
Misses 1605 1605 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tony
changed the title
CONTRIBUTING.md + WRITING.md
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
2 participants
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 985 lines to 66, across 11 changed files. No source, test, or CI file is touched.