Repository navigation
docs(sync): harmonize documentation after the lab merge - #69
Merged
Merged
Conversation
Resolved 22 cross-document conflicts. Deferred 4 items for human decision. First documentation sync anchor.
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.
No linked issue: this is the documentation sync after #67 and #68 brought the lab session into
main.What and why
After the lab merge, the docs disagreed with each other and with the tree. This PR fixes 22 of those disagreements in 14 files, one commit. When a claim could be checked against the code, the code decided. Otherwise the most recently edited line won, and the higher-level doc won when neither could be checked.
nix flake checkjob, plusvmTestHoloportInstallin its own job. The README used to say ten. The tests table addsvmTestServices,vmTestServices-noBootstrap,vmTestMossNodeandvmTestHoloportInstall, and names the checks that need no VM.sensorica-holoport-01was installed on 2026-09-27, while the five-machine fleet (Hardware: one Holoport boots vanilla NixOS from the workshop ISO (ADR-003 gate) #8 to Hardware: facilitator guide reviewed with Tibi, preflight sent seven days out #12) is still open.nixosModules, addingholochain-moss-nodeandsensorica-event-node.docs/architecture.mdfor the file-by-file list instead of repeating an old copy of it.[Unreleased]stopped at chore(example): lock nixos-holochain to main after the stack #23. It now covers every PR merged intomainthrough chore(fleet): pin nixos-holochain to main after the lab merge #68: new options, packages, modules and checks, the*_totalcounter change, and the fleet renames.holoport-installandvmTestHoloportInstall(feat(install): Holoport install script, runbook and a SeaBIOS VM check #61), and the first real Holoport install (feat: the lab session into main (Moss node service, Sensorica Holoport fleet, Grafana home page, mdBook) #67). The UEFI and Secure Boot question is still open.hosts/edgenode-XXbecomeshosts/sensorica-holoport-0N. There are five dashboards, not four, and none is titled "Holochain Fleet" any more (deployment guide,#fleettemplate).docs/architecture.mdlists every file undermodules/andpackages/, plus the Moss node's units. The introduction says seven modules, andSECURITY.mdlists the bootstrap and Moss modules.nixos-rebuild --rollbackbecomesnixos-rebuild switch --rollback. The 26.05nixos-rebuildrequires an action and only prints its help without one..#minimalhost, so the facilitator guide now names the fleet host instead..happfiles belong inhapps/.colmena applygets--impure.happs/README.md. The workshop-bundle table named Wind Tunnel and Moss. It is replaced by a pointer to the fleet README, where the hApp list lives.holochain-nixos-plan.md. This is the May plan. A "Superseded" note now says the tree wins wherever the two differ. The body is unchanged.Left alone on purpose:
hosts/edgenode-0*as Design: Workshop 2026 milestone (PM/Builder binôme record) #1 recorded it.docs/images/holochain-fleet-dashboard-2026-08-28.pngshows the dashboard before feat(grafana): four dashboards, each titled with its reader's question #65, and replacing it needs a new capture.modules/sensorica-event-node.nixstill says "the other four modules". Those are code, outside this docs pass.Commands run and what they printed
The drvPaths of all 28 root checks were compared between this branch and
mainat d335034, and 27 are identical. The exception ismoss-dashboard, which reads the source tree.VM tests built
All fourteen
vmTest*checks andmoss-dashboardwere built in onenix build --keep-goingrun on a KVM laptop. It exited 0 with 14vm-test-run-*outputs. The VM test derivations are the onesmainalready passed, andmoss-dashboardwas built new.vmTest,vmTest-0_6,vmTestWithHapp,vmTestWithHapp-0_6,vmTestConductorMetrics-0_6,vmTestGrafana,vmTestGateway,vmTestWindtunnel,vmTestWdocker,vmTestMossNode,vmTestBootstrap,vmTestServices,vmTestServices-noBootstrap,vmTestHoloportInstall: passedOption reference
docs/module-options.mdwas regenerated withcp "$(nix build .#options-doc --print-out-paths)" docs/module-options.mdin the same commit.Documentation
docs/(andREADME.md, if it says anything about this) updated in this PR, or nothing there describes the changed behaviour.