docs: reorganize user guide; split out Connecting to Your PiFinder (review §6)#466
Merged
Conversation
…oning glossary Leftover from the §3 build-configurations resolution that shipped in PR #460; records that user docs must scope 'N configurations' claims to a product generation. Co-Authored-By: Claude Fable 5 <[email protected]>
…eview §6)
user_guide.rst is now the workflow reference for operating & observing —
reordered per review §6 with no section renamed (all 33 inbound
autosectionlabel refs keep working):
- Quick Menu and Help System nest under The Menu System; Update Software
nests under Tools (it runs from the Tools menu)
- the WiFi / Web Interface / SkySafari-pointer / Shared Data Access block
moves verbatim to the new connectivity.rst ('Connecting to Your
PiFinder'); the guide keeps a short Connectivity at-a-glance section
with the field-critical facts (mode switch, PiFinderAP, pifinder.local)
- inbound refs retargeted in equipment, skysafari, menu_map,
troubleshooting; connectivity registered in the toctree
ADR 0010 records the page-granularity rule that drove this (standalone
page = direct arrival + separable from the operate-and-observe
storyline); the docs skill page table now carries the per-page charters
and the rule.
sphinx-build -n is warning-clean.
Co-Authored-By: Claude Fable 5 <[email protected]>
brickbots
added a commit
to mrosseel/PiFinder
that referenced
this pull request
Jun 12, 2026
Resolves the conflict with the overlay documentation: the Settings Menu section moved later in the user guide, so the Image... overlays mention is re-applied to the relocated section.
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
1 participant
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.
Continues the documentation review (§6 of the recommendations): reorganizes
user_guide.rstand applies a now-explicit rule for what lives in the guide vs. on a standalone page.The rule (new ADR 0010)
A topic earns a standalone page only when both hold:
By this rule
equipment,skysafari,catalogs,menu_map, andtroubleshootingstay standalone (their URLs are linked from the wild), while the connectivity block moves out of the user guide.user_guide's charter narrows to: the workflow reference for operating & observing — deeper than the Quick Start, deliberately not exhaustive, and printable.Changes
connectivity.rst— "Connecting to Your PiFinder": the WiFi / Web Interface / SkySafari-pointer / Shared Data Access sections move there verbatim. The guide keeps a 4-sentence Connectivity at-a-glance (mode switch in Settings,PiFinderAP,pifinder.local) so the printed guide still answers the field questions.user_guide.rstreordered per §6: How It Works → The Menu System (Quick Menu + Help System now nest under it) → Observing → Power & Charging → Settings → Connectivity → Tools (Status Screen, Update Software, Shutdown now nest under it). 8 top-level sections, down from 13.autosectionlabelrefs keep resolving; the 6 refs to moved sections are retargeted (equipment,skysafari,menu_map,troubleshooting).docs/ax/positioning/CONTEXT.mdscoping note that missed PR docs: apply documentation review fixes (§1–§5) #460.Verification
sphinx-build -n(nitpicky) is warning-clean against the pinneddocs/source/requirements.txtenvironment; rendered HTML checked for the new sidebar entry and heading order.🤖 Generated with Claude Code