docs: support-driven corrections and gap-filling - #604
Draft
brickbots wants to merge 1 commit into
Draft
Conversation
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>
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.
Works through the support-driven docs review of
docs/sourcecompiled 2026-08-10, verified page-by-page againstmainat 739b36b.Corrections
v3 - imx462. Stated insd_card,troubleshootingandmenu_map, using the literal menu strings. Matters most insd_card, since rev4's card slot is externally accessible.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
user_guidesection) — the ephemeris download, whySats seen/used 0/0is 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.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?".Verified against source, not carried over on trust
Sleep timer semantics (
main.pyPowerManager), lock type labels (ui/gpsstatus.py), catalog codes and the planet list (catalogs.py,comets.py, de421), the AFOVint()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-36the mapping is0: 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
Verification
python -m sphinx -b html -n -q source— zero 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