docs: publish ephemeral ADR navigation - #61
Merged
Conversation
Contributor
✅MegaLinter analysis: Success
Notices📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining See detailed reports in MegaLinter artifacts Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining
|
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.

Summary
doc/adr/README.mdintoREADME.intro.mdandREADME.outro.mddoc/adr/README.mdignored generated state rather than a committed derivativeadrctlv0.0.14 to the existing ADR-051-governeddependencies.txtmanifestmake adr-indextargetmake docsregenerate the ADR landing page before Doxygen without acquiring or repairing dependenciesdoc/adr/doc/threat_model.mdand its ADR-054-governed Mermaid diagrams outside the Doxygen rendering pathdoc/decisions.md*.sh=awkvendor/doxygen-bash.awkfilter-path typo while modifying the same integration surfaceArchitecture
ADR-051 remains authoritative for external build and development dependency acquisition. Bootstrap therefore continues to use the existing
dependencies.txtsource of truth rather than introducing a documentation-specific manifest or direct download path.make depsmay synchronize or repair dependency state.make deps-check,make adr-index, andmake docsremain offline and non-repairing after state has been prepared.The generated landing page is assembled atomically as:
An explicit blank line is inserted before the outro so section spacing does not depend on incidental
adrctlnewline behavior.Doxygen now includes maintained Bash source plus
doc/adr/and uses the generated ADR page asUSE_MDFILE_AS_MAINPAGE. It deliberately does not ingest the completedoc/tree, so this change does not turn Bootstrap's maintained Mermaid threat-model diagrams into a Doxygen-rendering migration.Dependency pin
The existing manifest adds:
adrctlis documentation tooling only. It is not an input to Bootstrap runtime behavior or to anydist/bootstrap*.bashconsumer artifact.Threat-model review
Adding executable development tooling is a review trigger under ADR-054. The current threat model was reviewed before this change.
The existing model already defines the build-dependency publisher actor to include future external build/development dependencies, defines AS-011 over
bashdepsand dependencies declared independencies.txt, and defines TM-016 for substitution of build dependency bytes in transit or cache. The pinned adrctl artifact falls within those existing boundaries and does not introduce a new runtime authority, release-artifact input, network path, or acquisition mechanism.Consistent with ADR-054's instruction to avoid synthetic threat-model churn when the security model is unchanged,
doc/threat_model.mdand its Mermaid diagrams are intentionally unchanged. ADR-055 records the completed review and its conclusion.Validation
The branch adds regression and workflow checks that require:
make docsfail without network repair;doc/adr/README.mdto be generated and contain ADR-055;doc/reference/index.htmlto be generated and ignored by Git;make deps-checkto remain successful after documentation generation;make distcleanto remove both generated documentation layers.The normal Bootstrap build, artifact, Bats, static-check, and runtime-independence contracts remain unchanged.
Concurrent work
Open PR #60 adds the conventional-commit governance document and repository documentation standard. This branch does not modify either of those paths and does not depend on that PR.