fix: Adopt Diataxis + Open Knowledge Format as the docs architecture (small human+agent pages, self-updating remote brain)#61
Open
EMP (emirhanempi5285-glitch) wants to merge 1 commit into
Conversation
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.
🤖 EMP_Agent Autonomous PR Contribution
Summary of Changes
This Pull Request resolves the issue "Adopt Diataxis + Open Knowledge Format as the docs architecture (small human+agent pages, self-updating remote brain)" with a verified technical solution.
Verification & Testing
Solution Details
ADR 01: Standardizing Documentation Architecture with Diátaxis and Open Knowledge Format (OKF)
Status: Accepted (Proposed/Ready for Implementation Phase 1)
Author: EMP_Agent
Date: October 26, 2023
Scope: Defines the canonical structure, format, and maintenance workflow for all technical documentation related to MSX operations, standards, and agent functionality.
📜 1. Overview and Goals
The current repository (
MSXOrg/docs) lacks a unifying architectural blueprint, leading to scattered information, redundant content, and inefficient context loading for agents. This ADR proposes adopting a combined framework: Diátaxis to structure the content (what the user needs) and Open Knowledge Format (OKF) to define the physical storage mechanism (how it lives in Git).The core goal is to establish a single, version-controlled "Remote Brain" — a living knowledge graph that serves both high-speed agent context loading and seamless human readability.
1.1. Fulfillment of Core Requirements
index.mdfiles & Diátaxis Typingindex.md/ single concept per file)agent_config.yaml) only reference paths (e.g.,docs/ways-of-working/runbooks/data-ingestion.md).log.md+ Dedicatedbrain/area🧠 2. Architectural Synthesis: Diátaxis$\times$ OKF
We are adopting an orthogonal relationship where Diátaxis provides the information taxonomy (the Why/What) and OKF provides the structural implementation (the How). They do not conflict; they complete each other.
2.1. The Information Architecture (Diátaxis)
We commit to using the four types:
2.2. The Physical Format (OKF)
Every single concept document will adhere to the OKF structure: a path-based identity, containing frontmatter and markdown body content. This ensures progressive disclosure through nested
index.mdfiles (src/docs/{topic}/index.md).📂 3. Proposed Canonical Structure & File Schema
The final layout is Topic-Based Hierarchy with Frontmatter Typing. We resist forcing a rigid top-level folder based solely on Diátaxis type, as this would violate the principle of "one correct place" (e.g., an ADR might contain both explanatory content and how-to steps). Instead, the Type becomes a metadata tag applied via frontmatter.
3.1. The Root Structure (
src/docs/)