mkdocs.yml

site_name: Spacedock
site_description: A multi-agent orchestrator where nothing ships without a decision.
site_url: https://spacedock.md/docs/
repo_url: https://github.com/spacedock-dev/spacedock
repo_name: spacedock-dev/spacedock
copyright: Spacedock is released under the Apache License 2.0.

docs_dir: docs/site

# Internal authoring directive (AGENTS.md), not a published page.
# Contributor docs are not hosted on the site; the repo is their source of truth.
exclude_docs: |
  AGENTS.md
  contributing/

theme:
  name: material
  custom_dir: overrides
  logo: brand/logo.svg
  favicon: brand/favicon.svg
  # Webfonts load from Bunny Fonts (GDPR-clean, no IP logging) via overrides/main.html,
  # not Material's built-in Google Fonts. brand.css restores --md-text-font/--md-code-font.
  font: false
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - search.highlight
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: false
      type: iso_datetime
      # A page with no git history yet (a newly added file) uses the build date
      # rather than aborting the strict build with a "no git logs" warning.
      fallback_to_build_date: true
      # Serial processing: the parallel default needs semaphore creation,
      # which is blocked under the sandboxed build environment. Serial cost
      # is negligible for this doc set.
      enable_parallel_processing: false
  - llmstxt:
      full_output: llms-full.txt
      markdown_description: >-
        Documentation for Spacedock, a multi-agent orchestrator where nothing
        ships without a decision. It lives within your existing coding harness
        (Claude Code, Codex, or Pi), breaks work into stages, and surfaces an
        evidenced decision at each gate. This index links the product docs;
        llms-full.txt is every page concatenated into one file for a single fetch.
      sections:
        Get started:
          - index.md
          - get-started/*.md
        Concepts:
          - concepts/*.md
        Running workflows:
          - running-workflows/*.md
        Advanced topics:
          - advanced/*.md
        Reference:
          - reference/*.md

nav:
  - Get started:
      - Welcome: index.md
      - Install: get-started/install.md
      - Survey your project: get-started/survey.md
      - Your first workflow: get-started/first-workflow.md
  - Concepts:
      - The operating model: concepts/operating-model.md
      - Workflows & entities: concepts/workflows-and-entities.md
      - The stage lifecycle: concepts/stage-lifecycle.md
      - Gates & decisions: concepts/gates-and-decisions.md
  - Running workflows:
      - Commission a workflow: running-workflows/commission.md
      - Operate a workflow: running-workflows/operating.md
      - Debrief a session: running-workflows/debrief.md
  - Advanced topics:
      - Mods & standing teammates: advanced/mods-and-standing-teammates.md
      - Multiple workflows: advanced/multi-workflow.md
      - Split-root state: advanced/split-root-state.md
      - Bridge an external tracker: advanced/external-tracker.md
      - Refit a workflow: advanced/refit.md
  - Reference:
      - Command reference: reference/command-reference.md
      - Frontmatter contract: reference/frontmatter-contract.md
      - Glossary: reference/glossary.md
      - Supported sandboxes: reference/sandbox.md
      - Contributing: https://github.com/spacedock-dev/spacedock/blob/main/CONTRIBUTING.md

hooks:
  # Enriches the per-page .md mirrors emitted by mkdocs-llmstxt with YAML
  # frontmatter and a ## Sitemap section (agent-readability markdown.frontmatter
  # and markdown.sitemap-section). Runs in on_post_build after llmstxt writes.
  - hooks/enrich_md_mirrors.py

extra:
  # Stamped into the per-page .md-mirror frontmatter (doc_version). Bump on release.
  doc_version: 0.20.2

extra_css:
  - stylesheets/tokens.css
  - stylesheets/brand.css

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      # Emit language-* classes on <code> (agent-readability code.language-tags).
      # Pygments highlights inline via <span> and drops the language-* class;
      # disabling it renders <code class="language-*"> instead of server-side
      # syntax coloring.
      use_pygments: false
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true