docs: audit sweep for stale claims, rotted refs, and prose polish - #73
Merged
Conversation
Consolidates four parallel reviewer-agent audits of docs/ into one pass: fix stale counts and constants drifted from source, swap rotting inline-file links for concept-level cross-doc links, alphabetize Sources sections, and rephrase the "X, not Y" / staccato-period prose that had crept into design and research docs.
Pass over the previous sweep's prose to replace clause-connecting em-dashes with transition words (since, because, while, where) and to combine the staccato short sentences that the first pass left behind. Em-dash is reserved for true parenthetical asides.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Apply the consensus fixes from three polish-review subagents: remaining em-dash-as-connector cases swapped for transition words (since, because, while), staccato runs combined with conjunctions, and one duplicated parenthetical restored where the previous rewrite lost the cleaner phrasing.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Summary
A doc-only sweep of
docs/that fixes stale claims drifted from source, replaces rotting inline file links with backticks or concept-level cross-doc pointers, normalizes Sources sections, and reworks the prose tics that had crept into design and research docs. 19 files touched,pnpm spellcheckandpnpm lintclean.The sweep was deferred during the
/resumePR after rewritingslash/resume.mdexposed several stale claims of the same shape lurking incommands.mdandmodals.md. Folding the cross-doc audit into one PR reads cleaner than piecemeal edits attached to feature work.Design decisions
crates/oxide-code/src/...paths, sorted alphabetically. Full paths are clickable in editors and unambiguous about what level of the tree we're naming. Line numbers stay out so the entries don't rot under refactors. Annotations stay one short clause.[X](../../../crates/.../x.rs)in prose rotted on every file split. Backticked names like`SearchableList`and[modals.md](modals.md)survive renames.modals.mdModalKeyblock was already stale (thePreviewvariant added in PR feat(slash): /theme picker with live preview #67 was missing). Rewriting it as four named outcomes with prose stays correct across future variant additions./resume'sroll_intovs. process replacement; thecchbody field vs. beta header) keep the antithesis. Body prose loses it:xxh64, not SHA-256becomesxxh64 for change detection, etc.since,because,while, andwherecarry the rewrite — defaulting to a period creates staccato fragmentation that reads worse than the original.Changes
docs/design/slash/commands.md/renameand/resumeadded to the inline list and Per-Command notes; antithesis decision titles softened; Sources alphabetized with full paths.docs/design/slash/modals.mdModalKeyrewritten semantically (now-stale 3-of-4 Rust block dropped); Per-Modal notes added for/renameeditor and/resumepicker; Decisions 1, 7, 8 rewritten without antithesis; em-dash chains turned into transition-word sentences; Sources alphabetized.docs/design/slash/resume.mdSearchableList/SessionRowdescriptions updated for the multi-line render and current field set (message_count,git_branch,project); decision titles softened; full repo paths in body links replaced with concept-level pointers; Sources alphabetized.docs/design/session/file-tracking.mddocs/design/session/persistence.mdWriterStatus::Pendingupdated to mention the deferred-title field added in PR #72.docs/design/tools/truncation.mdTRUNCATION_OVERHEADconstant50→80(matchestool.rs); "Head-tail, not tail-only" rewritten in positive form; Sources alphabetized.docs/design/tui/cancellation.mdStreaming . Esc/Running {tool} . Esc→ middot·matchingstatus.rs; Decision 6's antithesis rewritten; em-dash-as-connector cases swapped forsince/becauseclauses; Sources alphabetized.docs/design/tui/overview.mdtrait Componentpseudocode (no such trait exists); "11 named color slots" replaced with a slot-family description (the actual count is 30+ accessors); the staccato streaming-markdown paragraph combined into one cohesive sentence.docs/design/tui/welcome.mddocs/guide/configuration.mdmodelcellclaude-opus-4-7→claude-opus-4-7[1m](matchesDEFAULT_MODEL) in both the[client]table and the env-var table; "opt-in rather than automatic" rewritten as "you have to opt in explicitly"; OAuth-paragraph "matches Claude Code" implementation leak trimmed.docs/guide/instructions.mddocs/guide/sessions.md/renameinteraction with the AI title generator added to the Titles section.docs/guide/slash-commands.md/resumedescription's em-dash run split; persistence-stance em-dash dropped.docs/guide/theming.mdColor::Reset(internal Rust type) → user-facingreset; relative-paths antithesis sentence rephrased; "same routing applies in both modes" empty restatement dropped.docs/research/api/anthropic.mdprompt-caching-scopeparagraph reflows.docs/research/api/extended-thinking.mdsignature_deltaline restored to a clean parenthetical; credential-rotation em-dash chain split.docs/research/api/system-prompt.mddocs/research/slash/commands.mdoxide-codeVariants: 9→11.docs/roadmap.mdTest plan
pnpm spellcheck— cleanpnpm lint— cleancrates/oxide-code/src/BUILT_INS = 11,STARTER_POOL.len() = 9,TIP_POOL.len() = 9,TRUNCATION_OVERHEAD = 80,DEFAULT_MODEL = "claude-opus-4-7[1m]")[link](path)cross-doc references resolve