Skip to content

docs: support-driven corrections and gap-filling - #604

Draft
brickbots wants to merge 1 commit into
mainfrom
worktree-docs-support-review-2026-08-10
Draft

docs: support-driven corrections and gap-filling#604
brickbots wants to merge 1 commit into
mainfrom
worktree-docs-support-review-2026-08-10

Conversation

@brickbots

Copy link
Copy Markdown
Owner

Works through the support-driven docs review of docs/source compiled 2026-08-10, verified page-by-page against main at 739b36b.

Corrections

Item Change
Rev4 Straight Now says the screen sits at 45°, not "straight back". The old wording read as "rev4 reproduces v3's straight-back geometry", which argues rear-focus telescope owners out of the configuration that actually suits them.
Camera Type A rev4 takes v3 - imx462. Stated in sd_card, troubleshooting and menu_map, using the literal menu strings. Matters most in sd_card, since rev4's card slot is externally accessible.
SkySafari Dropped the version-by-version ranking. The floor is stated once, on the page's own requirements line: a paid version, 6 or later. The free version has no telescope control.
Dovetail One M5 bolt, not "two screws", and you don't remove the PiFinder from the telescope to tighten it.
Temperature Field reports run to 45°C/110°F, framed as observing reports and scoped as a unit-level figure rather than a battery rating.
Web nav label "Network Setup" in both places, matching python/views/base.html:19,30. The page previously contradicted itself.

Equatorial platforms (highest severity)

An alt-az telescope on an EQ tracking platform is still operated in alt-az. The docs told those owners to set Mount Type to Equatorial, which is precisely the misconfiguration that makes Push-To corrections jump around. Corrected in the Object Details note and in the troubleshooting FAQ.

Gaps filled

  • "Getting a GPS lock" (new user_guide section) — the ephemeris download, why Sats seen/used 0/0 is not a progress bar, why power cycling restarts the wait, why a phone is not a fair comparison, and what the lock types mean. Cross-linked from the quick start's GPS note, its GPS Status section, and a new "The GPS never locks" troubleshooting symptom.
  • Comets (CM) and Planets (PL) added to catalogs — both need a GPS lock; comet elements refresh automatically from the MPC, with the practical "power up on WiFi beforehand" advice. Plus a pointer to observing lists for "can I add my own objects?".
  • Sleep mode — only key presses hold the PiFinder awake. Motion wakes it but doesn't reset the timer, which is why polar alignment and slow slews dim the screen mid-task.
  • rev4 focus lock ring — documented, including refining focus under stars before locking it.
  • AFOV whole degrees — a decimal silently discards the eyepiece while still reporting "Eyepiece added".
  • Test Mode — surfaced in the FAQ as the cloudy-night answer.

Verified against source, not carried over on trust

Sleep timer semantics (main.py PowerManager), lock type labels (ui/gpsstatus.py), catalog codes and the planet list (catalogs.py, comets.py, de421), the AFOV int() parse (server.py:739), and the nav labels (views/base.html).

One correction to the review itself: it suggested "Limited vs Accurate" is 2D vs 3D. In ui/gpsstatus.py:29-36 the mapping is 0: Limited, 1: Basic, 2: Accurate (2D fix), 3: Precise (3D fix). So 2D vs 3D is Accurate vs Precise; Limited is a pre-fix state. Documented per the code.

Deliberately not done

  • Web login password contrast — the review itself says the real fix is CSS, not docs. Raising as a UI bug rather than documenting around it; no doc text added.
  • Items in section D (already shipped), and the two the review recommends against (#4 conversion guide, Beta #7 EQ-mount page, #12 PDF polish).

Verification

python -m sphinx -b html -n -q sourcezero warnings, clean build from scratch, baseline preserved. Style grep over the added lines shows no em-dashes, semicolons, or off-table terminology.

🤖 Generated with Claude Code

Works through the 2026-08-10 support review of docs/source.

Corrections:

- Rev4 Straight sits at 45 degrees, not straight back.  The old wording read
  as "rev4 reproduces v3's straight-back geometry", which talks rear-focus
  telescope owners out of the configuration that suits them.
- A rev4 takes the v3 - imx462 camera type.  Said so in sd_card,
  troubleshooting and menu_map, using the literal menu strings.
- Dropped the SkySafari version ranking.  Stated the floor once, on the page's
  own requirements line: a paid version, 6 or later.
- The dovetail foot is a single M5 bolt, and you don't take the PiFinder off
  the telescope to tighten it.
- Observing reports run to 45C/110F, and that is a unit-level figure rather
  than a battery rating.
- The web nav label is "Network Setup" in both the top bar and the mobile
  sidenav (python/views/base.html:19,30).  The page contradicted itself.

Equatorial platforms:

An alt-az telescope on an EQ tracking platform stays in Alt/Az.  The docs
instructed those owners into Equatorial, which is the misconfiguration that
makes corrections jump around.  Fixed in the Object Details note and in the
troubleshooting FAQ.

Gaps:

- New "Getting a GPS lock" section: ephemeris download, why "Sats seen/used
  0/0" is not a progress bar, why power cycling restarts the wait, why a phone
  is not a comparison, and what the lock types mean.  Cross-linked from the
  quick start and from a new "The GPS never locks" symptom.
- catalogs: added Comets (CM) and Planets (PL), both of which need a GPS lock,
  plus the automatic MPC element refresh.  Pointed at observing lists for
  "can I add my own objects?".
- Sleep mode: only key presses hold the PiFinder awake.  Motion wakes it but
  does not reset the timer, so polar alignment and slow slews dim the screen
  mid-task.
- Documented the rev4 focus lock ring, including focusing under stars before
  locking it.
- Equipment AFOV takes whole degrees; a decimal discards the eyepiece while
  still reporting "Eyepiece added".
- Test Mode surfaced in the FAQ as the cloudy-night answer.

Facts verified against source rather than carried over: sleep timer semantics
(main.py PowerManager), lock type labels (ui/gpsstatus.py), catalog codes and
planet list (catalogs.py, comets.py, de421), AFOV int() parse (server.py) and
the nav labels (views/base.html).

docs build: python -m sphinx -b html -n -q source -> zero warnings.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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