Skip to content

docs: correct appliance drift — RAUC reality, backup buttons future-tense, fixture consumers, resolved wizard-error item - #918

Merged
VijitSingh97 merged 1 commit into
develop-v2from
docs/appliance-doc-accuracy
Aug 13, 2026
Merged

docs: correct appliance drift — RAUC reality, backup buttons future-tense, fixture consumers, resolved wizard-error item#918
VijitSingh97 merged 1 commit into
develop-v2from
docs/appliance-doc-accuracy

Conversation

@VijitSingh97

Copy link
Copy Markdown
Collaborator

Audit-confirmed accuracy fixes (code is the source of truth; every claim checked against develop-v2):

  • docs/dev/dual-distribution-plan.md phase 2/4 described the abandoned Rugix Bakery updater and a release.sh os-image lane; now names the shipped stack — RAUC A/B + systemd-repart + the hand-written GRUB slot selector, the pithead-boot commit gate, the two-tier reset — and the actual manual image release process with a pointer to appliance-release.md.
  • Same file claimed dashboard backup/restore buttons exist; they do not — reworded to the planned surface with a Appliance feature parity: everything host-CLI-only is impossible on a shell-less box #786 cross-reference (that design is now decided there).
  • os/README.md said nothing consumes the quadlet fixtures; the byte-parity test has consumed them since the renderer shipped.
  • os/KNOWN-ISSUES.md still listed the wizard failure-surfacing gap as Open; error.txt/last-attempt.json shipped the fix — moved to the resolved section with the mechanism named.

make lint green (docs-voice, markdownlint). Verifier pass on the branch: clean. Ponytail: docs-only accuracy pass, nothing to cut.

🤖 Generated with Claude Code

… code

dual-distribution-plan.md's Phase 2/4 narrative still described the
abandoned Rugix Bakery/rugix-ctrl updater and an unbuilt release.sh
os-image lane, both contradicted by the document's own bake-off verdict
and by scripts/release.sh (no such lane exists). Rewrite both to match
what actually shipped: RAUC A/B + systemd-repart + the hand-written GRUB
slot-selector, and the manual mkimage.sh/mkbundle.sh flow in
appliance-release.md. The Phase 2 backup/restore paragraph asserted
dashboard export/restore buttons exist; they don't (os/KNOWN-ISSUES.md's
own #786 entry says so) — reworded to planned tense with a cross-reference.

os/README.md said the phase-0 quadlet fixtures are consumed by nothing;
tests/stack/run.sh diffs pithead's render-quadlet output against them as
the parity test's expected output, so reworded to say so.

os/KNOWN-ISSUES.md still listed the wizard's failure-surfacing gap as
Open; commit 7c6d4ec fixed it (error.txt + last-attempt.json, surfaced by
wizard.py/wizard.mjs) — moved to Resolved.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@VijitSingh97
VijitSingh97 merged commit d31e6f2 into develop-v2 Aug 13, 2026
15 of 16 checks passed
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.

1 participant