MkDocs documentation site for the Viable Systems Model Elixir implementation. Covers architecture, subsystem design, protocols, and package guides.
- Uses MkDocs with Python dependencies
- Deployed via GitHub Actions to GitHub Pages
- 2 mkdocs config files exist (
mkdocs.ymlandmkdocs-full.yml); unclear which is active - No Elixir code; documentation only
vsm-docs/
├── docs/
│ ├── index.md # Landing page
│ ├── overview/
│ │ ├── what-is-vsm.md
│ │ ├── why-vsm.md
│ │ └── key-concepts.md
│ ├── getting-started/
│ │ └── index.md
│ ├── packages/
│ │ ├── vsm-core.md
│ │ ├── vsm-connections.md
│ │ ├── vsm-rate-limiter.md
│ │ ├── vsm-security.md
│ │ └── compatibility-report.md
│ ├── protocol/
│ │ ├── algedonic-protocol.md
│ │ ├── ecosystem-integration.md
│ │ ├── implementation-guide.md
│ │ ├── message-format.md
│ │ └── telemetry-protocol.md
│ ├── subsystems/
│ │ └── s1-operations/
│ ├── guides/
│ │ ├── compatibility.md
│ │ └── rate-limiting.md
│ └── roadmap/
│ ├── overview.md
│ └── phases/phase-1.md
├── mkdocs.yml
├── mkdocs-full.yml
└── requirements.txt
| Package | Has doc page |
|---|---|
| vsm-core | Yes |
| vsm-connections | Yes |
| vsm-rate-limiter | Yes |
| vsm-security | Yes |
| vsm-goldrush | No |
| vsm-telemetry | No |
| vsm-starter | No |
| vsm-event-bus | No |
pip install -r requirements.txt
mkdocs serve
# Visit http://localhost:8000mkdocs build
# Output in site/- 4 of 8 VSM packages have no documentation pages
- Subsystems section only covers S1; S2-S5 are missing
- Roadmap phases only include phase 1
- Two mkdocs config files with no explanation of which to use
VSM_EXTERNAL_INTERFACES.mdexists at root level outside the docs/ structure- No API reference generation (e.g., from ExDoc)
MIT