Skip to content

📖 [Docs]: Document architecture and memory boundaries - #167

Merged
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
align-docs-architecture
Aug 9, 2026
Merged

📖 [Docs]: Document architecture and memory boundaries#167
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
align-docs-architecture

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Documentation now has an explicit, discoverable architecture for humans and agents: topic-first navigation, reader-need artifact tiers, minimal OKF-style metadata, and a separate durable-memory repository.

Changed: Documentation architecture

Contributors can now choose a page home by subject and artifact tier without duplicating a Diataxis taxonomy. The decision makes clear that reviewed knowledge stays in MSXOrg/docs, while durable working knowledge belongs in private MSXOrg/memory.

Changed: Navigation coverage

Every content directory now has an index. Deployment designs and Agentic Development decisions are visible in site navigation and generated indexes.


Technical details
  • Adds the immutable decision record for the documentation architecture, OKF-style metadata boundary, and memory boundary.
  • Extends the Documentation Model and contributor guidance with the chosen placement rule.
  • Adds the missing Capabilities/deployment/designs/index.md and wires nested navigation for deployment designs and agentic-development decisions.
  • Validation: regenerated and checked indexes; same-repository and cross-repository link checks; clean Zensical build; Update-DocumentationIndex.Tests.ps1 (6 passing tests).
  • Implementation plan progress: architecture decision, contributor guidance, navigation gap, and validation are complete.
Changed surface Standards checked Framework docs checked Result
src/docs/** Markdown, Documentation Documentation Model, Agentic Development Aligned
src/zensical.toml Documentation navigation Documentation Model Aligned
CONTRIBUTING.md Markdown Contribution Workflow, Documentation Model Aligned
Relevant issues (or links)

Related work

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 9, 2026 19:57
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 2abc522 into main Aug 9, 2026
21 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the align-docs-architecture branch August 9, 2026 19:59
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.

Adopt Diataxis + Open Knowledge Format as the docs architecture (small human+agent pages, self-updating remote brain)

1 participant