Skip to content

docs: convert the user guide to the house style - #597

Merged
brickbots merged 7 commits into
mainfrom
docs-ste/user_guide
Aug 10, 2026
Merged

docs: convert the user guide to the house style#597
brickbots merged 7 commits into
mainfrom
docs-ste/user_guide

Conversation

@brickbots

@brickbots brickbots commented Aug 8, 2026

Copy link
Copy Markdown
Owner

Full simplified technical English pass over docs/source/user_guide.rst, using the docs skill's seven rules and approved-term table. Part of the manual-wide conversion, one PR per file.

Measured change

  PASS  docs/source/user_guide.rst
     em-dash 99->0 | semicolon 30->0 | banned 55->20 | words 8514->8491 (-0%)
     terms: choose 17->1, pick 5->0, the display 2->0, the unit 6->1, the device 1->0, target 13->9, DSO 5->3
OVERALL: PASS

What the converting agent reported

EM_DASHES: 99 -> 0    (baseline was 99, not the 93 in the brief)
SEMICOLONS: 30 -> 0
TERMS: choose/choosing->select x12; pick->select x4; activates->selects;
  scope->telescope x18 (4 survivors are "polar scope", an approved fixed
  compound); the unit/the device->the PiFinder x6; display->screen/show x4;
  "switched off"->"turned off" x2; boot/booting->starts up x2;
  "back out"/"return to"->"go back" x4; "Holding X"->"press and hold X" plus 9
  further gesture normalisations, with the "Hold SQUARE and press +" chord left
  intact; "Pressing X brings up Y"->"Press X to open Y" x8;
  option->menu item x5 where the row was meant; DSO->deep-sky object x2 (the
  on-screen labels DSO Display / DSO... kept); "live target"->"live readout" in
  Polar Align, to avoid the object sense
STRUCTURAL: ~110 sentence splits, no procedure or step reordered. The IMU gloss
  lifted out of parentheses into its own sentence. The CSV row-resolution
  sentence split into five. Polar Align step 1 re-led with its command verb,
  same instruction and order. "And the magnitude and size..." (opened with a
  conjunction) rewritten.
LEFT_ALONE: all heading text, underlines and levels; "polar scope" x4; the
  on-screen DSO labels; "browse" x3 (the sense is looking through objects, not
  moving within a menu); the page's existing +/- and UP/DOWN key notation,
  since changing it would churn 12 lines for no rule; contractions; en-dashes
  in numeric ranges (7-10 deg, 0-360) and the U+2212 minus signs in the
  Contrast Reserve table; the rev4-default / v3-in-a-note convention.
FACT_CONCERNS:
  1. CROSS-PR ITEM. The key list under "The Menu System" carries an in-file
     comment saying it is duplicated in quick_start.rst and must be kept in
     sync. This pass converted it here (activates->selects, Holding->Press and
     hold), and the quick_start agent independently converted its own copy.
     The two must be reconciled before both PRs merge.
  2. "The Focus screen above offers HELP and Exposure" points at
     images/user_guide/quick_menu_00.png, introduced two lines earlier as the
     generic Quick Menu shot. If that image is not the Focus screen, the
     sentence is stale.
  3. The paragraph that began "And the magnitude and size..." had no explicit
     trigger; rendered as "The next press shows...", inferring it continues the
     SQUARE cycle described two paragraphs up. Worth a maintainer glance.
  4. Battery life said "the display sleep turned off"; written as "the screen
     sleep" for term consistency, but the real menu item appears to be Sleep
     Time under User Preferences.
  5. "images of every object in its catalog" - singular where the manual
     elsewhere says catalogs. Left as a fact.

Content changes (added after review)

  • "images of every object in its catalog" overstated what ships.
    astro_data/pifinder_objects.db holds 149,329 objects, of which 134,158 are
    double stars, 742 single stars and 90 triples. The non-stellar remainder is
    13,758, which matches software.rst's "13,000+ images" almost exactly: the
    image set covers the extended objects, not the star catalogs. The sentence now
    reads "images of all the extended objects in its catalogs", which also fixes
    the singular "catalog" flagged in FACT_CONCERNS.

  • Two escapes from the unit -> PiFinder rule. "appears on those units too"
    and "New units often ship a version or two behind" are now "PiFinders".

  • Two dead click-to-enlarge links. Same defect as build_guide: Sphinx
    emits a :target: value verbatim as an href, so a source-tree path 404s. The
    two CATALOG_images screenshots pointed at ../../images/screenshots/.
    Audited the built HTML: 5 of 7 targets resolved before, 7 of 7 after. The
    other five already used the _images/ form.

Safety

Every other change in this PR is style only. No numbers, procedures or step order were changed.

Verified mechanically against origin/main that every heading (text and underline character), every :ref:, :doc:, image path, substitution, include:: and external URL is unchanged. Headings matter because autosectionlabel turns each one into a cross-reference target that other pages depend on, and a rename would break them silently.

Sphinx builds clean under -n (nitpicky).

Any FACT_CONCERNS above that are not listed under Content changes were deliberately not fixed. They are reported for a maintainer decision, since changing them would be a content edit rather than a style one.

🤖 Generated with Claude Code

https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD

brickbots and others added 7 commits August 7, 2026 23:14
Full simplified technical English pass over docs/source/user_guide.rst, applying the seven
rules and the approved-term table from the docs skill.

  PASS  docs/source/user_guide.rst
     em-dash 99->0 | semicolon 30->0 | banned 55->20 | words 8514->8491 (-0%)
     terms: choose 17->1, pick 5->0, the display 2->0, the unit 6->1, the device 1->0, target 13->9, DSO 5->3
OVERALL: PASS

Style only. No facts, numbers, procedures or step order were changed.
Headings, cross-references, image paths and substitutions are unchanged,
verified mechanically against origin/main. Sphinx builds clean under -n.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Two cross-page fixes that only showed up once every page was converted.

The four-bullet key list is marked in-file as duplicated with quick_start.rst.
Both pages were converted independently and bullets 2 and 4 drifted. This is
the user_guide half of the reconciled wording; "return to" also violated the
go-back rule, and "jump" is what both pages already use for this action.

"one-off" was being used three ways on this page. Line 199 describes the same
feature menu_map calls a Custom Target, so it now says so. Line 564 is not a
Custom Target at all - it comes from an observing list - so it matches line
502's "one-off object". "target" now survives only inside the feature name.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
The active-voice pass rewrote "The PiFinder has been used from about -15C to
40C" as "Owners have used the PiFinder from...", which supplies a subject the
source never had. We do not actually know the range came from owners rather
than from bench testing, so the rewrite asserts more than the original.

Rule 2 allows the passive precisely here: the actor is genuinely unknown.
Restored.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Review flagged both as flattening the manual for no rule-compliance reason.

"as your night out demands" is not a phrase anyone says. The original read
"different ways to use (or skip!) these features for a great night out". It
is now "so use the features you want and skip the rest", which is plainer
than either and keeps the reader as the subject.

The Name Search entry lost "The Snowball planetary? Cat's Eye? This is the
way to find them." to a flat declarative. There was no em-dash, semicolon,
passive or auxiliary chain in it - nothing in the style sheet asked for the
change. The two questions are restored; the first half of the sentence keeps
its improved word order.

Simplified does not mean cold, which is what the house voice section says.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
"images of every object in its catalog" overstates what ships.
astro_data/pifinder_objects.db holds 149,329 objects, of which 134,158
are double stars, 742 single stars and 90 triples. The non-stellar
remainder is 13,758, which matches software.rst's "13,000+ images"
almost exactly: the image set covers the extended objects, not the
star catalogs.

Also fixes the singular "catalog" the conversion flagged; the images
span several catalogs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
The style pass replaced "unit" with "PiFinder" throughout, but missed
"appears on those units too" and "New units often ship a version or two
behind".

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Same defect as build_guide: Sphinx copies image sources into _images/
and rewrites the <img src>, but emits a :target: value verbatim as an
href, so a source-tree path 404s.

The two CATALOG_images screenshots pointed at
../../images/screenshots/. Audited the built HTML: 5 of 7 targets
resolved before, 7 of 7 after. The other five on this page already used
the _images/ form.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
@brickbots
brickbots marked this pull request as ready for review August 10, 2026 23:47
@brickbots
brickbots merged commit 8406c86 into main Aug 10, 2026
4 checks passed
@brickbots
brickbots deleted the docs-ste/user_guide branch August 10, 2026 23:47
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