Skip to content

docs(adr): move the design record from issues into docs/adr/ - #51

Merged
Soushi888 merged 3 commits into
mainfrom
docs/adr
Sep 28, 2026
Merged

Soushi888 merged 3 commits into
mainfrom
docs/adr

Conversation

@Soushi888

@Soushi888 Soushi888 commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

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

Closes #39.

Why

The design record lived in the descriptions of #1 and #15, although code comments across the repository cite ADR numbers. A reader of the code could not find the text those numbers point to without the issue tracker.

What

How to test

Commands run on this branch:

nix flake check --no-build --all-systems

Exit 0.

grep -n $'—' docs/adr/*.md

Exit 1 (no match): no em-dash in the new files.

A throwaway script resolved every relative link and anchor in docs/adr/*.md, docs/architecture.md and README.md: 27 links, 0 broken, including the two anchors into docs/architecture.md. The issue, PR and review-comment links were checked with gh issue view, gh pr view and gh api repos/Sensorica/nixos-holochain/issues/comments/<id>.

Each "Later record" statement about main was checked against the tree: flake.nix pins nixos-26.05 and holonix/main-0.7; modules/holochain-edgenode.nix renders lair_server_in_proc, relay_url on both lines, and hc sandbox call --running below 0.7; git log --merges shows the seven slice merges; templates/minimal/configuration.nix enables systemd-boot.

Not covered

One file per ADR, ADR-001 to ADR-017, each with status, date, source,
context, decision and consequences. Amendments to ADR-007, ADR-008,
ADR-009 and ADR-012 are recorded inside the ADR they amend. ADR-001 to
ADR-004 come from the May 2026 Phase 1 design, which was never
committed. docs/adr/README.md indexes them; docs/architecture.md and the
README layout link the directory.

Closes #39.
… ADR-010 from the gate

ADR-001 to ADR-004 came from the May 2026 design document, which lives only in a gitignored local file. Issue #39 scopes the move to ADR-005 to ADR-017 from #1 and #15, so their files are removed and the index lists them as not published. Restoring them is a revert of this commit's deletions once Soushi decides to publish that design.

- docs/adr/README.md: rows 001 to 004 marked not published; the intro and the reading notes no longer describe a transcription; the unused Superseded convention is dropped.
- docs/adr/0006 and 0012: the supersession cross-references to ADR-004 and ADR-002 are removed; ADR-006 says that the May design and its §4.5 are not in the repository.
- docs/adr/0010: Consequences states what the record gives; the slice order, the gate and the 01:58 gate amendment move under "Related record in #1", since #1 keeps them in their own sections.
- docs/architecture.md: the design record now spans ADR-005 to ADR-017.
@Soushi888 Soushi888 added the documentation Improvements or additions to documentation label Sep 27, 2026
@Soushi888

Copy link
Copy Markdown
Contributor Author

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

Response to the adversarial review of 7c0a4a9. Fixes are in 99094da.

  1. Major, ADR-001 to ADR-004 published from a private document: fixed by default-no. Verified: docs: move the ADRs from issues into docs/adr/ #39 scopes the move to ADR-005 to ADR-017, the source is a gitignored file, and no recorded decision covers publishing it. The four files are removed, the index lists 001 to 004 as "Not published: recorded in the May 2026 design, which is not in this repository", and the cross-references in ADR-006 and ADR-012 are gone. The text remains visible in 7c0a4a9 on this branch. If @Soushi888 wants them published, reverting the deletions of 99094da restores them.
  2. Minor, references to documents the repository lacks: fixed. The PRD references went with ADR-001 and ADR-002. ADR-006 now says the May design and its §4.5 are not in the repository, and that §4.5 was the Node.js fallback of the May design's installer decision (ADR-004), confirmed against the design's heading "4.5 Fallback installer, Node.js via @holochain/client".
  3. Minor, ADR-010 presents the slice order and the gate as its own text: fixed. Verified in Design: Workshop 2026 milestone (PM/Builder binôme record) #1: "Slice order", "Gate" and the 01:58 amendment are separate sections, and the 01:58 entry names the gate, not ADR-010. Consequences now says the record gives none; the three move under "Related record in Design: Workshop 2026 milestone (PM/Builder binôme record) #1", which states they are not part of ADR-010. Status stays Accepted, since Design: Workshop 2026 milestone (PM/Builder binôme record) #1 amends the gate, not ADR-010.
  4. Minor, inferred "Superseded by" statuses: fixed. Both statuses belonged to ADR-002 and ADR-004, which are no longer published, and the "Superseded" convention is dropped from the index since no file uses it. ADR-012 no longer claims to supersede ADR-002.
  5. Minor, hard-wrapped commit body of 7c0a4a9: rejected. Rewriting it needs an amend and a force-push, which this branch's workflow does not allow. The new commit's body is unwrapped. A squash merge would replace both messages if that matters.
  6. Minor, PR body overstates how the code cites ADR-001 to ADR-004: fixed. Verified that no file on main cites them. The body now says they are cited only by number, in Design: Workshop 2026 milestone (PM/Builder binôme record) #1 and in Hardware: one Holoport boots vanilla NixOS from the workshop ISO (ADR-003 gate) #8's title (ADR-003), and describes the new state.
  7. Minor, missing documentation label: fixed. Added.

Checks on 99094da: nix flake check --no-build --all-systems exits 0; grep -n $'—' docs/adr/*.md finds nothing; 27 relative links and 2 anchors in docs/adr/*.md, docs/architecture.md and README.md resolve.

Resolve the README docs/ layout tree: keep releasing.md from #49 and adr/ from this branch.
@Soushi888

Copy link
Copy Markdown
Contributor Author

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

Merged origin/main into docs/adr (47d9097) to bring the branch up to date after #36, #48, #49, #25, #34 and #62 landed. No rebase, no force-push.

Conflict resolved

What did not change

  • The review found no blocking items, so the ADR files, the index and the "Design record" section are untouched. The diff against main is still docs only: 16 files, +408/-0.
  • The index claim still holds on the merged tree: every ADR number cited outside docs/adr/ falls in 005 to 017 (the 001 and 004 hits are the architecture sentence that says they are not published), and none of the newly merged files cites an ADR.
  • No CHANGELOG line: nothing here is visible to someone running the modules, which is the bar CONTRIBUTING.md sets.

Local checks on 47d9097

  • nix flake check --no-build: exit 0, every check derivation evaluates, including the new holochain-bootstrap VM test from feat: holochain-bootstrap module and relayAllowPlainText #62.
  • Option reference: diff <(cat "$(nix build .#options-doc --print-out-paths)") docs/module-options.md prints options-doc in sync.
  • Every relative link in docs/adr/*.md and docs/architecture.md resolves.

Left for later, as the review suggested

  • ADR-017 still carries the open UEFI/Secure Boot question. Once the Holoport install work from the lab branch reaches main, a Later record entry citing scripts/holoport-install.sh, the SeaBIOS VM test and the 2026-09-27 install on sensorica-holoport-01 closes it.
  • When the Moss node doc (feat(packages): Moss wdocker 0.15.8 with its pinned Holochain 0.6.1 #60) lands, its moss-node.md line goes into the same docs/ tree block; keep both.

@Soushi888
Soushi888 merged commit 5441cb1 into main Sep 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs: move the ADRs from issues into docs/adr/

1 participant