Repository navigation
Apply the documentation voice rules to ARCHITECTURE.md - #8
Merged
Merged
Conversation
ARCHITECTURE.md had the same generated register the README pass removed:
83 em-dashes, most of them separating a label from its definition, plus a
few antithesis closers ("not silently relied upon", "not a silent third
option", "the safety net, not the front line") and slogan sentences that
restated the line before them ("Honest, per-protocol names beat one
overloaded surface", "`diagnose()` is the agent's oracle").
This reads the file against agent_development.md section 7 and fixes only
what trips a rule. Em-dashes drop to 10; the survivors set off a real
parenthetical or mark an abrupt turn. Label/definition em-dashes become a
verb, a colon or a run-in period. Sections 3, 6.2, 7.1, 7.4, 7.5, 8.3,
11 and 14 already read cleanly and are untouched.
Voice only. Every heading and section number, code block and table is
byte-identical, so the section references in code comments still resolve
and no documented contract changes.
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.
I applied the "Documentation Voice" rules (§7 of
docs/agent_docs/agent_development.md, added in #6) todocs/ARCHITECTURE.md. It's one commit that changes 214 lines, well under the 600-line cap, so every section is done and nothing is left for a follow-up.What changed
Em-dashes (rule 7.9): down from 83 to 10. Most sat between a label and its definition, as in
**\lablink/base.py`** — all type definitions…`. Each of those now uses a verb ("holds", "reads", "is the…"), a colon, or a bold label ending in a period.Antithesis closers (rule 7.2): removed where the "not X" half denied something nobody had claimed:
Kept where the contrast is real: "not hide them" in §15.4 (the other callers do hide the error), "not a driver method" in §17.1, and "code-sharing contract, not a tool-uniformity contract" in §6.
Sentences that repeated the line before them: removed "Honest, per-protocol names beat one overloaded surface" and "
diagnose()is the agent's oracle" (§2), and the "The practical implications:" lead-in (§10).Participial tails and long sentences (rules 7.4, 7.7): split into shorter sentences in §1, §8, §8.4, §9, §10 and §17.4, for example "…, deferred until real demand surfaces" and "Centralizing it at the single write point means…".
A few paragraphs in §4 and §7.3 that I edited were reflowed to the file's usual 80-column width.
Left alone: §3, §6.2, §7.1, §7.4, §7.5, §8.3, §11 and §14 already read cleanly. I also didn't touch the long single lines in §15; I only edited within them.
Content is frozen
A script compared the file against
HEADand found every heading, code block and table row byte-identical. No section was renumbered, reordered or merged, so references like "docs/ARCHITECTURE.md §8.3" inlablink/*.pystill point to the right place. Every data model, driver-contract rule, dispatch rule and invariant still says the same thing.Assumptions
Co-Authored-By: Claude Opus 5, as this task's instructions specified.Tests
.venv/bin/python -m pytest -qpassed with 386 tests before and after the change.Noticed but not changed (content, out of scope)
lablink/redaction.py, although §4 describes it.demo/is drawn as a second└──underinterfaces/. It's actually a sibling ofinterfaces/insidelablink/.🤖 Generated with Claude Code