vstack/mkdocs.yml at main · valani9/vstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
site_name: vstack
site_description: Organizational behavior, practiced on AI agents.
site_url: https://valani9.github.io/vstack/
repo_url: https://github.com/valani9/vstack
repo_name: valani9/vstack
edit_uri: edit/main/docs/
copyright: Copyright © 2026 Ilhan Valani

# Build the static site offline:
#   pip install mkdocs mkdocs-material
#   mkdocs build              # writes site/ -- can be opened directly
#   mkdocs serve              # local dev server on 127.0.0.1:8000
#
# Hosted at https://valani9.github.io/vstack/ via .github/workflows/docs.yml,
# which rebuilds + redeploys on every push to main that touches docs/,
# mkdocs.yml, or the workflow file itself.

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Quick start: quickstart.md
  - Concepts:
      - The 5-layer pattern shape: concepts/pattern-shape.md
      - Composition runbook: concepts/composition.md
      - Modes (quick / standard / forensic): concepts/modes.md
      - Calibration baselines: concepts/baselines.md
  - Patterns:
      - patterns/index.md
      - Module 1 — Individual: patterns/module-1.md
      - Module 2 — Team: patterns/module-2.md
      - Module 3 — Organizational: patterns/module-3.md
  - Surfaces:
      - Python imports + 34 CLIs: surfaces/python-and-clis.md
      - MCP server (Claude Desktop / Cursor / Cline / Continue): surfaces/mcp.md
      - REST API (FastAPI): surfaces/rest-api.md
      - Docker (GHCR): surfaces/docker.md
      - Claude Code skills: surfaces/skills.md
      - Framework adapters: surfaces/framework-adapters.md
      - Browser dev tooling: surfaces/browser.md
  - Workflows:
      - Memory + ~/.vstack/: workflows/memory.md
      - Learning store: workflows/learnings.md
      - Telemetry + cost: workflows/analytics.md
      - Upgrade: workflows/upgrade.md
      - Benchmarks: workflows/benchmarks.md
  - Reference:
      - CLI reference: reference/cli.md
      - Config keys: reference/config-keys.md
      - MCP resource URIs: reference/mcp-uris.md
      - REST API: reference/rest-endpoints.md
  - Operations:
      - Production deploy: operations/deploy.md
      - Security model: operations/security.md
  - Recipes:
      - recipes/index.md
      - Diagnose a confidently wrong agent: recipes/confidently-wrong.md
      - Audit a multi-agent crew: recipes/audit-crew.md
      - Spot a structural bottleneck: recipes/bottleneck.md
      - Run a culture check: recipes/culture-check.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search