Repository navigation
Apply the documentation voice rules to CONTRIBUTING.md and the agent docs - #10
Merged
Merged
Conversation
CONTRIBUTING.md, readme_agent.md and agent_development.md were the last
prose docs not yet read against agent_development.md section 7. They had
the same register the README and ARCHITECTURE passes removed: 32
em-dashes, most of them separating a label from its definition, plus a
few slogan sentences that restated the line before them ("One server,
many protocol drivers, one install", "This is a living, two-way
document", "This document is the codified collective memory").
Em-dashes drop to 1 outside the quoted Before examples in section 7; the
survivor in CONTRIBUTING.md marks a real turn. Label/definition dashes
become a colon, a verb or a full stop.
Section 7 itself contained an "X, not Y" closer ("a rhythm, not a fact
pattern") in the rule against rhythmic writing. It now states the claim
directly.
The two agent docs are instructions to be followed, so precision won
where it conflicted with voice. Prohibitions that deny something an
agent really does are kept ("not as a session diary", "a backstop, not
permission", "a bug, not a flake"), as are the bolded field labels
(Purpose, Your responsibility, Framework, Mocking) that the reader
scans for. Every heading, code block and table is byte-identical.
Co-Authored-By: Claude Opus 5 <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
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.
What changed
This finishes the documentation voice pass.
CONTRIBUTING.md,docs/agent_docs/readme_agent.mdanddocs/agent_docs/agent_development.mdwere the last prose docs not yet checked againstagent_development.md§7 (Documentation Voice). The section exists, so the task applied. I only fixed text that breaks one of its rules.**\README.md`** — what LabLink is…,Update docs — …,stateless — it receives…). Each became a colon, a verb or a full stop. The one left inCONTRIBUTING.md` ("Register it — one line in each of…") marks a real turn. The four inside the quoted Before examples in §7 are there on purpose.CONTRIBUTING.mdthat only listed what the document covers (§7.3/§7.5).Where precision won over voice
readme_agent.mdandagent_development.mdare instructions an agent has to follow. Where a smoother rewrite would have made a rule less exact, I kept the exact version:Not changed
main, which I checked with a diff. No rule or contract changed.agent_development.md, and §3 and §4 ofreadme_agent.md.CHANGELOG.md,docs/LAUNCH.mdordocs/system_connections_plan.md. There is no CHANGELOG entry because no behavior changed.Assumptions and a follow-up
## 7. Documentation Voice, which differs only in capitalization.README.md,docs/, andCHANGELOG.md". That list leaves outCONTRIBUTING.md, even though this task applies the rules to it. It also takes in the internal planning notes underdocs/that the task treats as out of scope. Fixing that line would change the spec's content, which this pass was told to leave alone, so I left it for a separate change.Testing
The full suite (
.venv/bin/python -m pytest -q) passed before and after the change: 393 tests.🤖 Generated with Claude Code