docs(appliance): document the installer's role select - #949
Merged
Conversation
The setup wizard's first question — Pithead / Pithead + RigForge / RigForge — decided the shape of the machine (including a rig with no dashboard at all) but was never mentioned in the appliance install doc. Add a self-contained "What is this machine?" section describing what each role produces, the rig's reduced three-question form and its no-login handoff card, and the merged HugePages budget the "Both" role shares between the coordinator and its built-in miner. Point the existing coordinator question table at it so readers know it does not apply to a rig. Verified against build/dashboard/mining_dashboard/web/static/wizard.mjs (role select + per-role field disclosure), the pithead script's role handling (record_machine_role, render_local_miner_config's PITHEAD_HUGEPAGES*2 reserve, render_rig_miner_config, no config.json or console login on a rig), and tests/os/run.sh's phase_rig assertions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Closes #925. Adds the "What is this machine?" section to docs/appliance.md — the wizard's first disclosure (Pithead / Pithead + RigForge / RigForge) was shipped and load-bearing but undocumented; an operator met the choice for the first time on the erase page. Every claim verified against wizard.mjs's per-role field disclosure, the pithead role handling (rig.json, no coordinator config, no containers on a rig), and the battery's rig-phase assertions. Verifier: pass. House voice, lint green. Ponytail: 35 doc lines, lean.
🤖 Generated with Claude Code