Skip to content

Wave 9 #109: Starlink perfect howto + diagram - #96

Open
bernardc6 wants to merge 1 commit into
mainfrom
subagent/starlink-perfect-howto
Open

Wave 9 #109: Starlink perfect howto + diagram#96
bernardc6 wants to merge 1 commit into
mainfrom
subagent/starlink-perfect-howto

Conversation

@bernardc6

Copy link
Copy Markdown
Collaborator

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

  • 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 the diagram.
  • docs/catalog/connectivity/starlink-diagram.svg — 1100×720 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 the SVG diagram. tier: b preserved; no other
    YAML changes.

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 the user doc (NOT in YAML)
  • No 'connection refused' raw error text; plain-English errors throughout
  • No marketing slop ('revolutionary', 'best-in-class', etc.)
  • No SUPERSEDED banners in the user-facing doc

Doctrine checklist

  • ✓ Verification is real (XML parsed, tests run, check.sh green)
  • ✓ Auto-recover documented (every path has a recovery row in
    troubleshoot: smart-plug REST fallback for Path B; re-run wizard for
    Path A; OpenWrt API token refresh for Path C)
  • ✓ Plain-English errors (no 'connection refused on http://...')
  • ✓ Idempotent (docs-only; re-run produces same content)
  • ✓ Backup-before-mutate (not needed — docs only)
  • ✓ Tier discipline (tier: b in YAML; tier-a promotion outline in
    user doc §'What tier-b means here')
  • ✓ No secrets in repo
  • ✓ User-facing repo hygiene (IKEA-style 5 steps; no SUPERSEDED in
    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.

…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.
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.

2 participants