Skip to content

docs: finish the scope → telescope normalisation - #600

Merged
brickbots merged 2 commits into
mainfrom
docs-ste/scope-to-telescope
Aug 10, 2026
Merged

docs: finish the scope → telescope normalisation#600
brickbots merged 2 commits into
mainfrom
docs-ste/scope-to-telescope

Conversation

@brickbots

Copy link
Copy Markdown
Owner

Finishes applying the approved term telescope across the manual, per the maintainer's decision.

The 13 conversion PRs (#586#598) already normalised every page they touched. Two files sat outside that pass and still said "scope":

  • index.rst (4) — the landing page. where the telescope is pointing, tracks telescope motion, sync … with your telescope, and my telescope just isn't built for solid encoder integration. That last one sat in a paragraph whose neighbouring sentences already said "my telescope" and "the telescope".
  • dev_guide.rst (1) — one word in the demo-mode note. This is not a style pass over the contributor docs, just the single term.

Deliberately not changed

These name different equipment, not the reader's telescope. Renaming them would introduce factual errors:

Kept Where Why
polar scope ×4 user_guide.rst The sighting device inside an equatorial mount. "Polar telescope" is not a term anyone uses, and the surrounding text is about aligning without one.
finder scope troubleshooting.rst A separate optical finder. The sentence exists to contrast it with the PiFinder.
scope type skysafari.rst SkySafari's own field label, confirmed against images/SkySafari/IMG_4796.jpeg. Excluded by the maintainer explicitly.

Verification

With this branch and all 13 conversion PRs merged together, the only standalone occurrences of "scope" left in docs/source/*.rst are exactly those six. Combined build is clean under -n.

🤖 Generated with Claude Code

https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD

brickbots and others added 2 commits August 8, 2026 16:27
The 13 conversion PRs applied the approved term to every page they touched.
These two files were outside that pass - index.rst is the landing page and
dev_guide.rst is a contributor doc - so they still said "scope".

index.rst (3): where the telescope is pointing, tracks telescope motion, and
sync ... with your telescope.

dev_guide.rst (1): one word in the demo-mode note. This is not a style pass
over the contributor docs, just the one term.

Deliberately NOT changed, because they name different equipment rather than
the reader's telescope:

- "polar scope" x4 in user_guide - the sighting device inside an equatorial
  mount. "polar telescope" is not a term anyone uses.
- "finder scope" in troubleshooting - a separate optical finder, and the
  sentence is contrasting it with the PiFinder.
- "scope type" in skysafari.rst - SkySafari's own field label, confirmed
  against images/SkySafari/IMG_4796.jpeg.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
index.rst:34 said "my scope just isn't built for solid encoder integration"
in a paragraph whose neighbouring sentences already say "my telescope" and
"the telescope". A one-line inconsistency in the author's own origin story.

It was hidden from my first sweep because the same line also contains the
word "telescope", so a filter meant to skip already-correct lines skipped it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
brickbots added a commit that referenced this pull request Aug 8, 2026
"telescope vs scope" was the one term-table row with no evidence winner
(72/67 in the old manual). The maintainer has settled it: telescope.

The manual is now converted, so the risk shifts from under-applying the term
to over-applying it. Four things keep "scope" because they name something
that is not the reader's telescope, and renaming them would be a factual
error rather than a style fix:

- polar scope - the sighting device inside an equatorial mount, and the
  Polar Alignment section is largely about aligning without one
- finder scope - a separate optical finder, mentioned to contrast it with
  the PiFinder
- SkySafari's "scope type" - a third-party field label
- OTA, finder shoe, Dobsonian - fixed compounds and product names

Also fixes a contradiction this exposed: SKILL.md's compact table listed OTA
in the "not these" column while the reference treats it as legitimate in a
parts context.

The general rule now stated once: quote any interface exactly as labelled,
whether it is PiFinder's or someone else's.

Manual-side change is in #600.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
brickbots added a commit that referenced this pull request Aug 10, 2026
* docs skill: split "turn on" from "boot" in the term table

Running the style pass across all 13 manual pages exposed a fault in the term
table. One row banned "boot" as a synonym for "turn on", so three agents made
three different calls: software converted boot -> start, while sd_card and
troubleshooting kept it and argued, correctly, that boot names the machine's
own startup sequence rather than the reader's action.

They are different concepts and the difference is load-bearing. "It won't
boot" and "it won't turn on" are different faults with different fixes: a bad
SD card lets the unit power on and then fail to boot. Two frozen headings
depend on the word, so it cannot leave the manual anyway.

The table now has a row for each, and section 4 explains why. Also settled
"one-off": a hand-entered coordinate is a Custom Target, an entry from an
observing list is an object.

Found by the cross-page review of PRs #586-#598, which is the check no
single-page pass can perform.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD

* docs skill: record the telescope decision and its exceptions

"telescope vs scope" was the one term-table row with no evidence winner
(72/67 in the old manual). The maintainer has settled it: telescope.

The manual is now converted, so the risk shifts from under-applying the term
to over-applying it. Four things keep "scope" because they name something
that is not the reader's telescope, and renaming them would be a factual
error rather than a style fix:

- polar scope - the sighting device inside an equatorial mount, and the
  Polar Alignment section is largely about aligning without one
- finder scope - a separate optical finder, mentioned to contrast it with
  the PiFinder
- SkySafari's "scope type" - a third-party field label
- OTA, finder shoe, Dobsonian - fixed compounds and product names

Also fixes a contradiction this exposed: SKILL.md's compact table listed OTA
in the "not these" column while the reference treats it as legitimate in a
parts context.

The general rule now stated once: quote any interface exactly as labelled,
whether it is PiFinder's or someone else's.

Manual-side change is in #600.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
@brickbots
brickbots marked this pull request as ready for review August 10, 2026 23:48
@brickbots
brickbots merged commit 739b36b into main Aug 10, 2026
3 of 4 checks passed
@brickbots
brickbots deleted the docs-ste/scope-to-telescope branch August 10, 2026 23:48
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