Docs: lean-pass rewrite of the user manual + succinct tone guidance#450
Merged
Conversation
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>
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.
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
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
.. note::..claude/skills/docs/SKILL.md.Bonus fixes caught along the way
:doc:cross-reference inuser_guide.rstthat was split across a line break (rendered as literal text).skysafari.rstheading hierarchy — sections were all top-level siblings of the title; now proper subsections.its/it's,philips→Phillips,PCB's→PCBs, a port-value self-contradiction in skysafari, double spaces.Notes for reviewers
user_guidepass 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.Verification
sphinx-build -b html -n -Eis clean — no warnings on any touched page (only the pre-existing repo-wide_staticpath warning remains).:ref:/:doc:counts verified equal toorigin/mainfor every page (the single:doc:delta in user_guide is the broken-link repair above).🤖 Generated with Claude Code