docs: add adr about nixago instrumentation

divnix · Jul 30, 2022 · a8a3000 · a8a3000
1 parent 88b21db
commit a8a3000
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 4 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -18,9 +18,10 @@
 - [Why `std`?](explain/why-std.md)
 
 - [Architecture Decisions](explain/architecture-decision-records/Readme.md)
-  - [Increase Repo Discoverability With a Tui](explain/architecture-decision-records/0001-increase-repo-discoverability-with-a-tui.md)
-  - [Wire Up Documentation Instrumentation](explain/architecture-decision-records/0002-wire-up-documentation-instrumentation.md)
-  - [Drop `as-nix-cli-epiphyte` flag](explain/architecture-decision-records/0003-drop-as-nix-cli-epiphyte-flag.md)
+  - [0001 Drop `as-nix-cli-epiphyte` flag](explain/architecture-decision-records/0003-drop-as-nix-cli-epiphyte-flag.md)
+  - [0002 Wire Up Documentation Instrumentation](explain/architecture-decision-records/0002-wire-up-documentation-instrumentation.md)
+  - [0003 Increase Repo Discoverability With a Tui](explain/architecture-decision-records/0001-increase-repo-discoverability-with-a-tui.md)
+  - [0004 Add Nixago Instrumentation](explain/architecture-decision-records/0004-add-nixago-instrumentation.md)
 
 # Reference
 

diff --git a/...ain/architecture-decision-records/0002-wire-up-documentation-instrumentation.md b/...ain/architecture-decision-records/0002-wire-up-documentation-instrumentation.md
@@ -4,7 +4,9 @@ Date: 2022-04-20
 
 ## Status
 
-accepted
+superseded
+
+Superseded by [4. Add Nixago Instrumentation](0004-add-nixago-instrumentation.md)
 
 ## Context
 

diff --git a/docs/explain/architecture-decision-records/0004-add-nixago-instrumentation.md b/docs/explain/architecture-decision-records/0004-add-nixago-instrumentation.md
@@ -0,0 +1,33 @@
+# 4. Add Nixago Instrumentation
+
+Date: 2022-07-29
+
+## Status
+
+accepted
+
+Supersedes [2. Wire up documentation instrumentation](0002-wire-up-documentation-instrumentation.md)
+
+## Context
+
+The current implementation of mdbook instrumentation and adrgen instrumentation is brittle and ad-hoc.
+Furthermore, the making these two "special" is a contentious decision.
+
+Adjacently, oftentimes, there are other "repo dotfiles" that we want to somehow centrally manage (and
+auto-update), instead of copy pasting them for the n-th time.
+
+Recently, the Nixago project has seen the face of the earth which deals precisely with repo dotfile
+templating and linking/copying.
+
+## Decision
+
+Implement a first class integreation with Nixago and add the appropriate glue-code to work seamlessly
+together with Devshells.
+
+Ship some generic Nixago Pebbles as part of the `std` Celle.
+
+## Consequences
+
+- mdbook / adgen dotfile templating is no more "special"
+- user can make use of this instrumentation to template _any_ repo dotfile
+- user can reuse the shipped Nixago Pebbles and take inspiration from our dogfooding