docs(nixos): Migration context + developer NixOS page#497
Open
brickbots wants to merge 1 commit into
Open
Conversation
Net-new docs on main for the Raspberry Pi OS -> NixOS migration, filling the gap the unmerged NixOS PR (#379) leaves on main and built to merge cleanly when it lands. - docs/ax/migration/CONTEXT.md: glossary for the new Migration context (in-place migration, migration gate, migration enable, pre-flight checks, migration tarball, migration initramfs, preserved data, migration progress display). Reserves "migration" for the OS-level event and renames the per-version data fixups to "post-update actions". - docs/ax/migration.md: architecture deep-dive of the RAM-staged initramfs reflash, end to end. - docs/source/nixos.rst: dev-focused guide page covering in-place migration, image build, and system update; wired into the "For developers" toctree. - CONTEXT-MAP.md: platform-lifecycle grouping; Migration (live) + NixOS (forward-referenced to #379) and their relationships. Cross-links to docs/ax/nixos/ and nixos/RELEASE.md are intentional forward references that resolve when #379 lands. Sphinx strict build (-W) passes clean. Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
Summary
Net-new documentation on
mainfor the forthcoming Raspberry Pi OS → NixOS migration. Scoped to fill the gaps the unmerged NixOS PR (#379) leaves onmain, and built to merge cleanly when #379 lands (it cross-links to, rather than duplicates, the NixOS docs that arrive with that PR).Three dev-focused areas:
nixos/RELEASE.md, arrives with NixOS support #379).Changes
docs/ax/migration/CONTEXT.md— glossary for a new Migration context: in-place migration, post-update actions, migration gate, migration enable, pre-flight checks, migration tarball, migration initramfs, preserved data, migration progress display — with flagged ambiguities and an example dialogue.docs/ax/migration.md— architecture deep-dive: trigger paths (gate vs. enable), the all-or-nothing pre-flight, the RAM-staged initramfs reflash sequence, the point of no return, and gotchas.docs/source/nixos.rst— developer guide page covering all three flows; wired into the For developers toctree.CONTEXT-MAP.md— new "platform lifecycle" grouping (Migration live, NixOS forward-referenced to NixOS support #379) and their relationships.docs/source/index.rst— toctree entry.Terminology
Resolves the overloaded word "migration":
migration_source/v*.sh) are renamed post-update actions..img.zst) and system update (the NixOS closure swap) are kept distinct.Notes
docs/ax/nixos/andnixos/RELEASE.mdare intentional forward references that resolve when NixOS support #379 merges — not broken links.nixos/RELEASE.md/brickbots-attic-setup.mdcite "ADR 0001/0004" for the Attic cache while the file isnixos/adr/0001— a stale reference to fix there, untouched here.Testing
sphinx-build -b html -W --keep-going) passes with zero warnings; the new page, toctree entry, and:ref:to the dev guide all resolve.🤖 Generated with Claude Code