📖 [Docs]: Add Open Knowledge Format to the Dictionary - #34
Merged
Conversation
Marius Storhaug (MariusStorhaug)
added
the
documentation
Marius Storhaug (MariusStorhaug)
added a commit
that referenced
this pull request
Aug 9, 2026
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. --- <details> <summary>Technical details</summary> - 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 | - Issue convergence sweep: #10 is fully addressed by the recorded decision; its previously referenced PowerShell standards issues (#2–#8) are already closed. </details> <details> <summary>Relevant issues (or links)</summary> - Resolves #10 ### Related work - References #34 - References #51 - References #70 </details> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
Adds Open Knowledge Format (OKF) to the Dictionary so the term has one shared definition across the MSX docs, defined once the same way for every human and agent that meets it.
OKF is the vendor-neutral "knowledge as plain Markdown + YAML frontmatter, one concept per file" format from Google Cloud. It is already in use in the ecosystem: the
MSXOrg/Cleoknowledge repository was just aligned to be a conformant OKF v0.1 bundle, and adopting OKF as the docs architecture is the subject of #10.The change is intentionally small and additive — a single Dictionary entry linking the specification. It does not alter the documentation architecture itself; that decision (Diátaxis + OKF, ADR-gated) stays with #10.
Technical Details
src/docs/Dictionary/index.md(alphabetical, after LTS).Update-DocumentationIndex.ps1 -Checkpasses (no page added; indexes unchanged).Test-DocumentationLink.ps1— "All documentation links resolve."