Skip to content

Docs: lean-pass rewrite of the user manual + succinct tone guidance#450

Merged
brickbots merged 1 commit into
mainfrom
worktree-docs-tone-quickstart
May 30, 2026
Merged

Docs: lean-pass rewrite of the user manual + succinct tone guidance#450
brickbots merged 1 commit into
mainfrom
worktree-docs-tone-quickstart

Conversation

@brickbots
Copy link
Copy Markdown
Owner

What

A "warm but lean" pass across all nine reader-facing documentation pages, plus an update to the docs skill's house-voice guidance that codifies the new direction.

The goal: keep the manual's warm, direct "you" voice, but cut the padding so it reads tighter at the eyepiece. ~14% fewer words (≈3,100 cut) with every image, cross-reference, note, and caveat preserved.

Pages leaned

Page Words
quick_start 4075 → 3265 (20%)
user_guide 6114 → 5312 (13%)
build_guide 6247 → 5604 (10%)
catalogs 488 → 422 (14%)
v25_upgrade 1056 → 880 (17%)
software 1036 → 936 (10%)
skysafari 740 → 641 (13%)
equipment 1078 → 1003 (7%)
troubleshooting 2098 → 2008 (4%)

Lighter trims (build_guide, software, troubleshooting, equipment) are expected — those pages are mostly steps, measurements, commands, and symptom→fix checks, so only prose padding came out.

Kinds of changes

  • Cuts: throat-clearing ("In order to…", "It is important to note…"), redundant restatement, and hedging. The why is kept but compressed to a clause; longer asides moved into .. note::.
  • Structure: multi-step procedures became numbered lists where images don't interleave the steps (kept as bullets where they do, since rST restarts numbering after each image).
  • Tone guidance: added a "Be succinct" principle and reframed "explain the why""compress the why" in .claude/skills/docs/SKILL.md.

Bonus fixes caught along the way

  • Repaired a broken :doc: cross-reference in user_guide.rst that was split across a line break (rendered as literal text).
  • Fixed skysafari.rst heading hierarchy — sections were all top-level siblings of the title; now proper subsections.
  • Assorted its/it's, philipsPhillips, PCB'sPCBs, a port-value self-contradiction in skysafari, double spaces.

Notes for reviewers

  • The user_guide pass was re-run on top of the newly merged Power & Charging / LiPo safety section (Docs: add Power & Charging section to user guide (incl. LiPo safety) #447) — that section and its safety warnings are preserved in full and leaned alongside the rest.
  • No toctree or page renames; heading levels and underline characters unchanged (except the intentional skysafari fix).

Verification

  • sphinx-build -b html -n -E is clean — no warnings on any touched page (only the pre-existing repo-wide _static path warning remains).
  • Image/figure/:ref:/:doc: counts verified equal to origin/main for every page (the single :doc: delta in user_guide is the broken-link repair above).

🤖 Generated with Claude Code

Apply a "warm but lean" pass to all nine reader-facing documentation
pages, trimming ~14% of words (≈3,100) while preserving every image,
cross-reference, note, and caveat. Cuts are throat-clearing, redundant
restatement, and hedging; the "why" is kept but compressed to a clause,
and longer asides moved into notes. Multi-step procedures become numbered
lists where images don't interleave the steps.

Pages: quick_start, user_guide, build_guide, catalogs, v25_upgrade,
software, skysafari, equipment, troubleshooting. The user_guide pass
preserves the newly added Power & Charging section and LiPo safety
warnings. Also fixes a broken :doc: cross-reference in user_guide that
was split across a line break, corrects the skysafari heading hierarchy
(sections were all top-level), and cleans up assorted its/it's and typo
issues found in passing.

Codify the new direction in the docs skill's house-voice guidance: add a
"Be succinct" principle and reframe "explain the why" as "compress the
why".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@brickbots brickbots merged commit 937eaa0 into main May 30, 2026
1 check passed
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