Restructure System Operation into a user-first Daily Operation page - #47
Conversation
Code Review — PR #47Scope: The two P1 product findings were independently re-verified by the orchestrator against halpid and firmware source before being reported here. P1 — High
P2 — Moderate
P3 — Low
Applied fixes (commit a55bf35)
Pre-existing (action taken)
Coverage
VerdictNot ready. The docs work itself is sound, but items 1–2 mean the PR currently documents two commands that do not do what they say; the docs stance on those (warn vs remove) plus items 4, 8, 9, 10, 12 and the voltage decision (5) need resolution before merge. Fix order: 1–2 docs stance → 8/9/10/12 edits → 4 nav keys → 5 voltage decision. Review-fix commits will be folded into their topic commits before merge. 🤖 Generated with Claude Code |
a55bf35 to
0848ca7
Compare
|
Review follow-up — resolution of the gated findings (decisions by @mairas):
Review-fix commits are folded into their topic commits; the branch was force-pushed (history: 5 commits, 🤖 Generated with Claude Code |
0848ca7 to
34a1355
Compare
Translation statusda — 20 current Every translation of the pages in scope is current. |
Replace the two Technical Reference placeholders with the internals formerly on the System Operation page: operating modes, shutdown sequences, watchdog, standby, the authoritative LED/state table, and configuration defaults. Facts verified against HALPI2-firmware source, the production test suite, and a live device (fw 3.3.1): watchdog default is 10 s, standby has shipped with the 'halpi shutdown --standby' CLI form, and auto_restart is disabled at production test on units made since early 2026 (firmware fallback: enabled). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Rewrite the first User Guide page for the mainstream user: automatic power management lead, powering on and off with the optional auto-restart behavior explained, a LED table in user vocabulary, power-loss reassurance, health check, and a daemonless-fallback callout. The firmware internals now live in the Technical Reference. The status-led-indicators anchor is preserved. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Getting Started pointed to the operation page for four procedures that live in the Hardware Guide (CM5/NVMe reseating, current limit switch, enclosure access), and retold the shutdown story in full; it now links to Daily Operation. Set the input voltage to the official 10-32 VDC everywhere, including the Hardware Reference. Reconcile the troubleshooting LED table with the firmware patterns, fix the standby CLI syntax, drop references to a nonexistent Common Use Cases section, and retarget links orphaned by the navigation pruning. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Rename System Operation to Daily Operation, retitle the technical reference interfaces page to Interface Reference (nav and H1) to deduplicate the two identical titles, flatten the single-page Getting Started section, order the User Guide by usage frequency, and remove empty placeholder pages from the nav (files kept). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
34a1355 to
08ac643
Compare
|
Fact correction: the firmware constant |
Translate the rewritten Daily Operation, Carrier Board Controller, Power Supply Deep Dive, and FAQ pages into all nine languages, and apply the English link, voltage, LED-table, and standby-syntax changes to the eight diff-touched pages per locale. Update nav_translations for the renamed titles and drop keys for entries removed from the nav. Extend the per-language glossaries with the new terminology. Every page is stamped; translation_status reports all locales current. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Why
The first User Guide page front-loaded firmware internals (Solo/Co-op modes, shutdown state sequences, watchdog mechanics) that are invisible to anyone running HaLOS or halpid, while the things every owner needs — what the LEDs mean, how shutdown works — were buried at the bottom or written in firmware vocabulary. It also carried facts that contradict the firmware. Plan and fact sheet: issue #46 (phase 1, English only).
How
user-guide/operation.md, same URL,#status-led-indicatorsanchor preserved): task-first rewrite — automatic power management lead, powering on/off with the auto-restart behavior up front, LED table in user vocabulary, power-loss reassurance, health check, daemonless-fallback callout, blinkenlights pointer.controller.mdreceives the modes, sequences, watchdog, standby, authoritative LED/state table, and config defaults;power-supply.mdreceives the input stage, current limiting, and super-capacitor detail.halpi shutdown --standby --time …(halpi standbydoes not exist), troubleshooting LED table reconciled withled_patterns.rs(three documented patterns did not exist in firmware).All 9 locale editions are synced in this PR: the four rewritten pages are fully re-translated, the eight diff-touched pages carry the equivalent edits, nav_translations covers the renamed titles, and every page is stamped (
translation_statusreports all locales current).mkdocs build --strictpasses; 10,610 anchors across 202 pages resolve; per-language glossary and typography checks pass.Part of #46 (phase 1 — does not close it).
🤖 Generated with Claude Code