Skip to content

docs(sync): harmonize documentation after the lab merge - #69

Merged
Soushi888 merged 1 commit into
mainfrom
docs/sync-after-lab
Sep 28, 2026
Merged

Soushi888 merged 1 commit into
mainfrom
docs/sync-after-lab

Conversation

@Soushi888

Copy link
Copy Markdown
Contributor

SoushAI analysis. Drafted by Soushi's AI assistant, reviewed and posted by @Soushi888.

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.

Left alone on purpose:

Commands run and what they printed

$ nix run nixpkgs#alejandra -- .
(no .nix file changed)

$ nix flake check --no-build --all-systems --accept-flake-config
exit 0

$ cd examples/sensorica-fleet && nix flake check --no-build --accept-flake-config --override-input nixos-holochain "path:$(git rev-parse --show-toplevel)"
exit 0

$ diff <(cat "$(nix build .#options-doc --print-out-paths)") docs/module-options.md
(no output: in sync)

$ mdbook build
INFO HTML book written to `book` (no warning)

The drvPaths of all 28 root checks were compared between this branch and main at d335034, and 27 are identical. The exception is moss-dashboard, which reads the source tree.

VM tests built

All fourteen vmTest* checks and moss-dashboard were built in one nix build --keep-going run on a KVM laptop. It exited 0 with 14 vm-test-run-* outputs. The VM test derivations are the ones main already passed, and moss-dashboard was built new.

  • vmTest, vmTest-0_6, vmTestWithHapp, vmTestWithHapp-0_6, vmTestConductorMetrics-0_6, vmTestGrafana, vmTestGateway, vmTestWindtunnel, vmTestWdocker, vmTestMossNode, vmTestBootstrap, vmTestServices, vmTestServices-noBootstrap, vmTestHoloportInstall: passed

Option reference

  • No option was added, changed or removed.
  • Options changed, and docs/module-options.md was regenerated with cp "$(nix build .#options-doc --print-out-paths)" docs/module-options.md in the same commit.

Documentation

  • docs/ (and README.md, if it says anything about this) updated in this PR, or nothing there describes the changed behaviour.

Resolved 22 cross-document conflicts.
Deferred 4 items for human decision.
First documentation sync anchor.
@Soushi888
Soushi888 merged commit dfe6c7a into main Sep 28, 2026
5 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