Skip to content

docs: audit sweep for stale claims, rotted refs, and prose polish - #73

Merged
hakula139 merged 3 commits into
mainfrom
docs/audit-sweep
May 9, 2026
Merged

docs: audit sweep for stale claims, rotted refs, and prose polish#73
hakula139 merged 3 commits into
mainfrom
docs/audit-sweep

Conversation

@hakula139

@hakula139hakula139 commented May 9, 2026

Copy link
Copy Markdown
Owner

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 spellcheck and pnpm lint clean.

The sweep was deferred during the /resume PR after rewriting slash/resume.md exposed several stale claims of the same shape lurking in commands.md and modals.md. Folding the cross-doc audit into one PR reads cleaner than piecemeal edits attached to feature work.

Design decisions

  • Sources sections keep full 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.
  • Inline body references switch to backticks or concept-level cross-doc links.[X](../../../crates/.../x.rs) in prose rotted on every file split. Backticked names like `SearchableList` and [modals.md](modals.md) survive renames.
  • Trait-shape claims described semantically rather than as literal Rust. The modals.mdModalKey block was already stale (the Preview variant 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.
  • Research docs keep their implementation depth. Research docs document external systems (Claude Code, Codex, opencode, Anthropic API) and earn their detail. The sweep there is wording consistency only — antithesis trims, em-dash chain splits, stale counts.
  • "X, not Y" rewritten in the body, sometimes preserved in titles. Decision titles where the contrast IS the load-bearing rationale (/resume's roll_into vs. process replacement; the cch body field vs. beta header) keep the antithesis. Body prose loses it: xxh64, not SHA-256 becomes xxh64 for change detection, etc.
  • Prose connectors over em-dashes and period fragmentation. Em-dash is reserved for true parenthetical asides, not for stitching two independent clauses together. When trimming em-dash / semicolon overuse, transitions like since, because, while, and where carry the rewrite — defaulting to a period creates staccato fragmentation that reads worse than the original.

Changes

FileDescription
docs/design/slash/commands.md"Nine built-ins" → eleven; /rename and /resume added to the inline list and Per-Command notes; antithesis decision titles softened; Sources alphabetized with full paths.
docs/design/slash/modals.mdModalKey rewritten semantically (now-stale 3-of-4 Rust block dropped); Per-Modal notes added for /rename editor and /resume picker; Decisions 1, 7, 8 rewritten without antithesis; em-dash chains turned into transition-word sentences; Sources alphabetized.
docs/design/slash/resume.mdSearchableList / SessionRow descriptions 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.md"xxh64, not SHA-256" rewritten in positive form; Sources alphabetized.
docs/design/session/persistence.mdEm-dash chains in actor-batching and resume-sanitization paragraphs converted to conjunction-joined sentences; WriterStatus::Pending updated to mention the deferred-title field added in PR #72.
docs/design/tools/truncation.mdTRUNCATION_OVERHEAD constant 5080 (matches tool.rs); "Head-tail, not tail-only" rewritten in positive form; Sources alphabetized.
docs/design/tui/cancellation.mdStatus hints Streaming . Esc / Running {tool} . Esc → middot · matching status.rs; Decision 6's antithesis rewritten; em-dash-as-connector cases swapped for since / because clauses; Sources alphabetized.
docs/design/tui/overview.mdDropped fictional trait Component pseudocode (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.md"9 entries" → 11 (full registry size); "8-entry STARTER_POOL / TIP_POOL" → 9-entry; antithesis decision titles softened; em-dash chain in the live-feeds Out-of-Scope item turned into a conjunction; Sources alphabetized.
docs/guide/configuration.mdDefault model cell claude-opus-4-7claude-opus-4-7[1m] (matches DEFAULT_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.md"More specific locations override broader ones" softened to "files closer to your working directory appear later in the prompt and conventionally take precedence", which matches the actual concatenate-in-walk-order behaviour.
docs/guide/sessions.mdMid-session resume description loses the implementation-internal "load + sanitize pipeline" phrase; /rename interaction with the AI title generator added to the Titles section.
docs/guide/slash-commands.mdTheme bullet's comma-spliced enumeration restructured; /resume description's em-dash run split; persistence-stance em-dash dropped.
docs/guide/theming.mdColor::Reset (internal Rust type) → user-facing reset; relative-paths antithesis sentence rephrased; "same routing applies in both modes" empty restatement dropped.
docs/research/api/anthropic.mdPer-model beta-set body trimmed of one staircase-narration sentence; em-dash chain on first-party-vs-3P fingerprint paragraph rewritten with conjunctions; "billing plumbing, not a security boundary" reworded; prompt-caching-scope paragraph reflows.
docs/research/api/extended-thinking.mdsignature_delta line restored to a clean parenthetical; credential-rotation em-dash chain split.
docs/research/api/system-prompt.md"absent → default (org-scoped) ephemeral cache. Universally accepted" tightened; org-default rationale's three-clause stack rewritten as a colon-introduced list.
docs/research/slash/commands.mdComparison table oxide-codeVariants: 911.
docs/roadmap.md"and bash output" dropped from rich-tool-views (bash uses the fallback view); silent-merge "Rejects Claude Code's …" parenthetical inlined; status-bar follow-up sentence flow tightened.

Test plan

  • pnpm spellcheck — clean
  • pnpm lint — clean
  • All Sources entries verified to exist under crates/oxide-code/src/
  • All count-bearing claims verified against source (BUILT_INS = 11, STARTER_POOL.len() = 9, TIP_POOL.len() = 9, TRUNCATION_OVERHEAD = 80, DEFAULT_MODEL = "claude-opus-4-7[1m]")
  • All [link](path) cross-doc references resolve

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.
@hakula139hakula139 self-assigned this May 9, 2026
@hakula139hakula139 added the documentation Improvements or additions to documentation label May 9, 2026
@codecov

codecovBot commented May 9, 2026

Copy link
Copy Markdown

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.
@hakula139
hakula139 merged commit 07be6d4 into mainMay 9, 2026
4 checks passed
@hakula139
hakula139 deleted the docs/audit-sweep branch May 9, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@hakula139