Wave 9 #109: Starlink perfect howto + diagram - #96
Open
bernardc6 wants to merge 1 commit into
Open
Conversation
…roubleshoot + tier-a promotion outline Context: Bernard's priority 4 (chat #7563-7574) — Starlink docs were 'OK but not great'. Wave 9 #108 (PR #85) shipped the 3-path wizard; this slice ships the user-facing companion doc that points users at the right wizard path. Changes: - docs/catalog/connectivity/starlink.md: rewritten as 5-step IKEA guide with SVG 'what plugs into what' diagram (Dish -> Router -> Smart plug -> HA -> RoamCore) and 7-mode troubleshoot section. Path A/B/C marked on diagram. - docs/catalog/connectivity/starlink-diagram.svg: 1100x720 SVG showing the 3 setup paths color-coded (blue/orange/green) with a 'which path am I?' cheat-sheet at the bottom. - connections/starlink/docs/recipe.md: brought into sync with the user-facing doc, slightly more technical, references the wizard PATH_STARLINK_MINI_ONLY / PATH_SEPARATE_ROUTER / PATH_VP2430_VM_ROUTER constants from connections/starlink/__init__.py. Includes §0 wizard-at-a-glance, per-path §3/§4/§5, and §10 tier-a promotion outline. - connections/starlink/connection.yml: ONE-LINE description addendum pointing at docs/catalog/connectivity/starlink-diagram.svg. tier: b preserved. Verification: - bash scripts/check.sh --core-only -> GREEN (exit 0) - python3 xml.etree.ElementTree parse on docs/catalog/connectivity/starlink-diagram.svg -> VALID XML (18 rects, 20 lines, 51 texts) - cairosvg render to PNG -> renders cleanly (3 paths visible, legend legible) - 6/6 starlink pytest tests pass (test_id_matches_folder_name, test_tier_b_without_tier_a_markers, test_requires_docs_recipe_published, test_category_matches_existing_legacy_doc, test_dashboard_tiles_follow_rc_naming, test_status_reflects_no_real_starlink) - User doc has 5 IKEA steps + 7 troubleshoot modes (>=5 required) - Recipe has all 11 required sections (§0..§10) including wizard PATH_* constants - Tier-a promotion outline lives in user doc (NOT in connection.yml) - No 'connection refused' raw error text; plain-English errors throughout - No marketing slop ('revolutionary', 'best-in-class', 'world-class', 'industry-leading') - No SUPERSEDED banners in user-facing doc Rollback: revert this PR; the previous Starlink docs are still in git history.
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.
Wave 9 #109: Starlink perfect howto + diagram — 5-step IKEA + SVG + troubleshoot + tier-a promotion outline
Context
Bernard chat #7563-7574 priority 4: Starlink docs were 'OK but not great'.
Wave 9 #108 (PR #85) shipped the 3-path wizard; this slice ships the
user-facing companion doc that points users at the right wizard path.
Changes
guide with SVG 'what plugs into what' diagram (Dish → Router → Smart
plug → HA → RoamCore) and 7-mode troubleshoot section. Path A/B/C
marked on the diagram.
showing the 3 setup paths color-coded (blue/orange/green) with a
'which path am I?' cheat-sheet at the bottom.
the user-facing doc, slightly more technical, references the wizard
PATH_STARLINK_MINI_ONLY/PATH_SEPARATE_ROUTER/PATH_VP2430_VM_ROUTERconstants fromconnections/starlink/__init__.py. Includes §0 wizard-at-a-glance,per-path §3/§4/§5, and §10 tier-a promotion outline.
addendum pointing at the SVG diagram.
tier: bpreserved; no otherYAML changes.
Verification
bash scripts/check.sh --core-only→ GREEN (exit 0)python3 xml.etree.ElementTree.parseondocs/catalog/connectivity/starlink-diagram.svg→ VALID XML(18 rects, 20 lines, 51 texts)
cairosvgrender to PNG → renders cleanly (3 paths visible,legend legible)
test_id_matches_folder_name,test_tier_b_without_tier_a_markers,test_requires_docs_recipe_published,test_category_matches_existing_legacy_doc,test_dashboard_tiles_follow_rc_naming,test_status_reflects_no_real_starlinkPATH_* constants
Doctrine checklist
troubleshoot: smart-plug REST fallback for Path B; re-run wizard for
Path A; OpenWrt API token refresh for Path C)
user doc §'What tier-b means here')
user tree; no marketing slop)
Rollback
Revert this PR; the previous Starlink docs are still in git history.
Doctrin reference
Bernard (2026-08-04) 'must not fail + super intuitive + critical
infrastructure' — applied throughout. Sleep state, wake button, signal
tile, reachability tile are the four tiles a van-dweller needs to
trust Starlink; the doc makes them obvious in five steps with the
diagram showing the wiring at a glance.