docs(quick_start): split Configuration Setup into rotate, set type, and a reference - #651
Merged
Merged
Conversation
…nd a reference Configuration Setup covered five topics in one continuous passage: rotating the rev4 body, the PiFinder Type setting, the three rev4 positions, the Analog Sky entries, and the v3 / v2.5 note. Readers on Cloudy Nights and Discord asked for it to be broken up, and a new rev4 owner could not find PiFinder Type from the step as written. Split it into three sub-sections under the existing heading: Rotating the Body, Setting the PiFinder Type, and PiFinder Type Entries. The heading "Configuration Setup" and its level are unchanged, so the inbound :ref:s from troubleshooting.rst and software.rst still resolve. Also corrected against menu_structure.py: there are exactly three rev4 entries, and the entries immediately above them are AS Bloom and AS Heart, not the v3 / v2.5 configurations, which are the five at the top of the list. Noted the "Options for DIY PiFinders" message that Advanced shows on open, since it reads as a wrong turn to a ready-built owner. Closes #648 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The three screenshots for "select Settings, scroll down to Advanced, then select PiFinder Type" skipped the middle step: settings_select.png shows the main menu and settings_menu_config.png is already titled Advanced, so nothing showed Advanced highlighted within Settings. That is the step the Discord report lost, since Advanced sits below the fold and needs six DOWN presses to reach. The images now map one to one onto the three steps of the prose chain. Captured at rev4 176x176 with the battery monitor on, so the title bar matches its neighbours, then run through screenshot_to_doc.py. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Owner
Author
|
Follow-up commit The three images for "select Settings, scroll down to Advanced, then select PiFinder Type" skipped a step:
|
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.
Quick Start step 4 covered five topics in one continuous passage. This splits it into the three-part shape #648 asks for, without moving or renaming the section itself.
New structure
Configuration Setup(unchanged, still--underlined) now contains three^-underlined sub-sections, matching the heading ladder the page already uses under "First Time Out":rev4_convert.gif, the spring-loaded detents, and a pointer to the reference below for readers who don't yet know which position they want... note::.A short paragraph stays directly under the section heading to frame it as two steps.
Cross-references
Inbound
:ref:s toquick_start:configuration setupstill resolve. The heading text and its level are unchanged, so the label is untouched. Verified in the built HTML that all four still point at a real#configuration-setupanchor:docs/source/troubleshooting.rst:216docs/source/troubleshooting.rst:311docs/source/software.rst:72docs/source/quick_start.rst:280(the Mounting note, in-page)The three new sub-sections add
quick_start:rotating the body,quick_start:setting the pifinder typeandquick_start:pifinder type entries. None collides with an existing heading on the page.Facts checked against the code
Verified the option list and its on-device labels in
python/PiFinder/ui/menu_structure.py. Two corrections to the previous prose:Rev4 Left,Rev4 Right,Rev4 Straight.Also added a sentence about the "Options for DIY PiFinders" message that
Advancedshows for two seconds on open (callbacks.show_advanced_message). A ready-built owner following this route hits it and can read it as a wrong turn, which is close to the Discord report in the issue.No screenshots were re-taken. The three existing images are already at the rev4 352x352 size and still show the right screens.
Verification
python -m sphinx -b html -n -q source /tmp/sphinx_648prints nothing (exit 0). The added lines contain no em-dashes or semicolons, and match the page's one-space-after-full-stop convention.Closes #648
🤖 Generated with Claude Code