Repository navigation
Conversation
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.
Contributor
Author
Response to the adversarial review of 7c0a4a9. Fixes are in 99094da.
Checks on 99094da: |
1 task
Resolve the README docs/ layout tree: keep releasing.md from #49 and adr/ from this branch.
Contributor
Author
Merged Conflict resolved
What did not change
Local checks on 47d9097
Left for later, as the review suggested
|
6 of 7 tasks
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.
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
docs/adr/0005-*.mdtodocs/adr/0017-*.md: one file per ADR, each with Status, Date, Source, Context, Decision and Consequences.mainno longer matches the recorded text and the record was not amended, each with its link: the 0.6 installer onhc sandbox calland the 0.6 network section carryingrelay_url(feat(edgenode): conductor and hApp at boot on both Holochain lines, VM-tested (slice 2) #16), nixpkgs on 26.05 (chore(flake): move nixpkgs to nixos-26.05, fix its three breakages (slice 6) #20), the stack landing as seven merge-committed slices (ADR-010), the PNG ruling on ADR-012 (feat(observability): conductor metrics, provisioned dashboard, opt-in Wind Tunnel runner (slice 3) #17 review), and the boot loader moving out of the hardware stubs (fix: review hardening across the stack, installer, admin origin, templates, Grafana secrets (slice 7) #21, ADR-017). These are observations with evidence, not new decisions.docs/adr/README.mdindexes all seventeen numbers with status and source, and explains the conventions. Every number from 005 to 017 referenced in the repository, Design: Workshop 2026 milestone (PM/Builder binôme record) #1 or Research record 2026-08-28: Holo ecosystem state and ADR amendments 007/008/009, 015/016/017 #15 has its text.docs/architecture.mdgains a "Design record" section linking the index; the README layout tree listsdocs/adr/.How to test
Commands run on this branch:
Exit 0.
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.mdandREADME.md: 27 links, 0 broken, including the two anchors intodocs/architecture.md. The issue, PR and review-comment links were checked withgh issue view,gh pr viewandgh api repos/Sensorica/nixos-holochain/issues/comments/<id>.Each "Later record" statement about
mainwas checked against the tree:flake.nixpinsnixos-26.05andholonix/main-0.7;modules/holochain-edgenode.nixrenderslair_server_in_proc,relay_urlon both lines, andhc sandbox call --runningbelow 0.7;git log --mergesshows the seven slice merges;templates/minimal/configuration.nixenables systemd-boot.Not covered
docs/adr/there is a separate call.