zordon/mkdocs.yml at main · piotrkowalczuk/zordon · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
site_name: Zordon
site_description: A process supervisor for local agentic workflows — supervised host processes, declared in an Alphasfile.
site_url: https://zordon.io/
repo_url: https://github.com/piotrkowalczuk/zordon
repo_name: piotrkowalczuk/zordon
edit_uri: edit/main/docs/

# Strips the GitHub-only canonical banner from every page — see the hook.
hooks:
  - scripts/mkdocs_gh_banner.py

theme:
  name: material
  custom_dir: overrides
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# Analytics loads only once consent is granted; the copyright link below is how
# a visitor withdraws it afterwards.
copyright: >
  <a href="#__consent">Change cookie settings</a>

extra:
  analytics:
    provider: google
    property: G-HSVQ91KVP2
  consent:
    title: Cookie consent
    description: >-
      We use cookies to measure how this documentation is used and whether
      readers find what they came for. Analytics stay off until you accept.
    actions:
      - accept
      - reject
      - manage

nav:
  - Overview: index.md
  - Getting started: getting-started.md
  - Concepts: concepts.md
  - Architecture: architecture.md
  - Lifecycle: lifecycle.md
  - Alphasfile: alphasfile.md
  - Dynamic configuration: dynamic-config.md
  - Services:
      - Go: services/go.md
      - Rust: services/rust.md
      - Ruby: services/ruby.md
      - Node.js: services/nodejs.md
      - Java: services/java.md
      - Package (pkg): services/pkg.md
  - Workspaces: workspaces.md
  - Federation: federation.md
  - How-to:
      - Run a provision via MCP: how-to/run-a-provision-via-mcp.md
      - Drive a host stack from a container: how-to/drive-a-host-stack-from-a-container.md
      - Use a binary from another service: how-to/use-a-binary-from-another-service.md
      - Install a CLI tool from a mise package: how-to/install-a-cli-tool-with-mise.md
      - Clean up provision side effects: how-to/clean-up-provision-side-effects.md
      - Filter noisy service logs: how-to/filter-noisy-logs.md
      - Install the Claude Code plugin: how-to/install-the-claude-code-plugin.md
      - Install the MCP bundle: how-to/install-the-mcp-bundle.md
      - Run parallel agents with workspaces: how-to/run-parallel-agents-with-workspaces.md
  - Reference:
      - Binaries and layout: reference/binaries.md
      - zordon mcp: reference/mcp.md
      - Log filter DSL: reference/log-filter.md
  - Compare:
      - Overview: compare/index.md
      - vs Docker Compose: compare/docker-compose.md
      - vs a container per agent: compare/devcontainers.md
  - Blog: blog/index.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets

plugins:
  - search
  # Acquisition content lives outside the Diátaxis tree: these pages address
  # people who do not use zordon yet, which documentation deliberately does not.
  - blog:
      blog_dir: blog
      post_url_format: "{slug}"
      archive: false
      categories: false
      authors: false
  - llmstxt:
      markdown_description: >-
        Zordon supervises the supporting stack local agentic and development
        workflows run against — databases, brokers, proxies and services
        declared in an Alphasfile and run as ordinary host processes, so a
        stack is cheap to stand up, duplicate and throw away.
      full_output: llms-full.txt
      sections:
        Overview:
          - index.md
          - getting-started.md
          - concepts.md
        Architecture:
          - architecture.md
          - lifecycle.md
          - workspaces.md
          - federation.md
        Configuration:
          - alphasfile.md
          - dynamic-config.md
        Services:
          - services/*.md
        How-to:
          - how-to/*.md
        Compare:
          - compare/*.md
        Guides:
          - blog/posts/*.md
        Reference:
          - reference/*.md