Skip to content

Editing pass over the docs and code comments before the v0.2.0 release - #184

Merged
MJohnson459 merged 6 commits into
mainfrom
task-458-docs-editing
Aug 20, 2026
Merged

Editing pass over the docs and code comments before the v0.2.0 release#184
MJohnson459 merged 6 commits into
mainfrom
task-458-docs-editing

Conversation

@MJohnson459

Copy link
Copy Markdown
Contributor

Editing pass over the docs and code comments before v0.2.0, on branch task-458-docs-editing (4 commits, split as the task asked).

Commit 1 (7e41d40) is the rewrap alone: DESIGN.md hard-wrapped at 80 columns (byte length, so the acceptance awk passes under a byte-counting awk too). Verified as a no-op on the rendered text by mechanically rejoining the wrapped lines and comparing paragraph-by-paragraph against the original — 167 paragraphs, zero differences. Fenced code blocks and table rows byte-identical.

Commit 2 (3520b89) is the trim: cut passages narrating how a design point evolved, what it replaced, or what was rejected (fork-delivery story, the pre-repos migration narrative, the incomplete-report marker-placement history, the planning-session reversal story, the liveness-source rule-it-replaces, the not-done listing history, and the like), keeping rationale where the alternative is still live. Header block rewritten — no more "Status: Draft / Date: 2026-07-08"; it now states what the document is. §10 reframed as a record of the staged delivery (structure kept, second-person coaching removed). §11 shrunk to per-question resolution notes; headings 1–12 and the (a)/(b)/(c) anchors preserved, so all 646 §-references in code still resolve (checked §1–§12, §11a, §11c against the headings).

WORD COUNT, flagged for your judgement: 32,494 → 28,750, about 12% — short of the third the task named as a reasonable aim. Judged passage by passage, the rest of the doc is operative design plus still-live rationale of exactly the kind the task says to keep (much of it decision records you have previously asked to keep — scoring bonuses, the pr verb, the gutter rendering). Cutting to ~22k words means dropping recorded decision rationale wholesale; say the word and I will make that pass, but I did not want to do it silently. The task itself listed the word target under "where I was guessing".

Commit 3 (1b426d2) is the code-comment pass: all 76 task/PR citations removed across both crates (plus the bare #NNN forms the count missed), DESIGN.md §-pointers kept, and the handful of used-to/defect-N/corrected comments rephrased to state the invariant instead of the history. The diff is comment-only — verified mechanically that no added or removed line is a non-comment line.

Commit 4 (d120696) is the satellite docs: agent-integration.md trimmed where it restated DESIGN.md §8 and its over-long snippet lines wrapped; voro-cli SKILL.md fixed — it documented voro answer <id> TEXT, a verb that no longer exists (now voro resume, no answer text recorded); verify SKILL.md fixed — refresh is ctrl-r now that r refines, and the cap-phrase list it named (3 phrases) is superseded by CAP_SIGNATURES (8) in voro-core; README needed only a hyphen.

Also flagged, not fixed: §11's note (b) still claims a git diff --stat summary in the detail pane as one of the three diff paths — I kept the claim verbatim and did not verify that pane exists; if it never shipped, that sentence is a §10-style judgement call for you. The §6 state table rows and the agent-integration hook-table rows remain over 80/100 columns — tables cannot wrap without breaking, which the task exempts; the hook-table cells were shortened substantially instead.

Verified: cargo test --workspace (4 binaries, all ok), cargo clippy --workspace --all-targets -D warnings clean, cargo fmt --all --check clean, awk 'length>80' on DESIGN.md shows only fence contents and table rows, grep -rE 'task #[0-9]+' over crates returns nothing, CHANGELOG.md untouched.

MJohnson459 and others added 5 commits August 19, 2026 11:22
Every paragraph was a single unwrapped line — 123 lines over 400
characters, the longest 7,245 — unreadable in a terminal and turning
every edit into a whole-paragraph diff. Wrap at 80 columns to match
README.md, docs/agent-integration.md and CLAUDE.md.

This commit is formatting only: fenced code blocks and table rows are
byte-identical, and rejoining the wrapped lines reproduces the original
text exactly. Content edits come separately.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
Cut passages that narrated how a design point evolved, what it
replaced, or what was considered and rejected, keeping rationale only
where the alternative is still live. Break the two longest single
paragraphs (voro.toml, planning sessions) into topical ones. Rewrite
the header block: the document is no longer a dated draft. Reframe §10
as a record of the staged delivery and shrink §11 to short resolution
notes, keeping the 1-12 numbering and the (a)/(b)/(c) anchors that code
comments cite. Fenced code blocks are byte-identical to the previous
commit.

The word count drops from 32,494 to 28,750. The remaining prose is
operative design and its still-live rationale, judged passage by
passage rather than forced to a target.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
Remove the 76 task/PR citations from comments across both crates —
that provenance lives in git and in Voro itself — keeping the
DESIGN.md section pointers, which are load-bearing cross-references.
Rephrase the handful of comments that described what a change replaced
rather than what the code is for. The diff is comment-only: no
non-comment line is added or removed.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
agent-integration.md: shorten the passages that restate DESIGN.md §8
(liveness, quick message, fork delivery, the hook table) to operative
instructions plus a pointer, and wrap the two over-long snippet lines.

voro-cli SKILL.md: `voro answer` no longer exists — document
`voro resume`, which records no answer text.

verify SKILL.md: refresh is `ctrl-r` now that `r` refines, and the cap
phrase list lives in voro-core's CAP_SIGNATURES, which is wider than
the three phrases the skill named.

README.md: hyphenate "attention-based"; the rest still describes the
tool accurately.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
Same rule as the comment sweep: provenance lives in git and in Voro,
comments state what the code is for. Comment-only.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
@MJohnson459
MJohnson459 force-pushed the task-458-docs-editing branch from d120696 to e3d5e06 Compare August 19, 2026 10:31
A comment that defends a choice against an alternative only the
history suggests — not forking a message send, a badge that "used to
mislead", a check a keypress "no longer waits on" — reads as noise to
anyone who was not there. Keep a contrast only where the code itself
raises the question. Comment-only.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XY97HiyTQVXBHXTZZySDDS
@MJohnson459
MJohnson459 merged commit 26752a4 into main Aug 20, 2026
7 checks passed
@MJohnson459
MJohnson459 deleted the task-458-docs-editing branch August 20, 2026 11:12
MJohnson459 added a commit that referenced this pull request Aug 20, 2026
Takes the v0.2.0 editing pass (#184), which hard-wrapped DESIGN.md, stripped
task-number citations from code comments, and cut comments that narrate what a
change replaced. Conflicts were the re-wrap crossing this branch's new prose and
the test section header it renamed.

DESIGN.md is taken from main wholesale and this branch's three edits re-applied
into the wrapped text, so the paragraph structure stays main's. The new comments
follow the pass's conventions: no task numbers, DESIGN.md section pointers kept,
and the two spots that said "before this" rewritten to say what the code is for.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant