mkdocs.yml

site_name: CORA
site_description: An agent-native operations platform for large-scale research facilities
site_url: https://xmap.github.io/cora/
site_author: Doga Gursoy

repo_url: https://github.com/xmap/cora
repo_name: xmap/cora
edit_uri: edit/main/docs/

docs_dir: docs

theme:
  name: material
  custom_dir: overrides
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - navigation.expand
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Architecture:
    - architecture/index.md
    - Model: architecture/model.md
    - State: architecture/state.md
    - Surfaces: architecture/surfaces.md
    - Standards: architecture/standards.md
    - Modules:
      - architecture/modules/index.md
      - Run: architecture/modules/run/index.md
      - Safety: architecture/modules/safety/index.md
      - Caution: architecture/modules/caution/index.md
      - Calibration: architecture/modules/calibration/index.md
      - Agent: architecture/modules/agent/index.md
      - Campaign: architecture/modules/campaign/index.md
      - Operation: architecture/modules/operation/index.md
      - Supply: architecture/modules/supply/index.md
      - Access: architecture/modules/access/index.md
      - Equipment: architecture/modules/equipment/index.md
      - Recipe: architecture/modules/recipe/index.md
      - Trust: architecture/modules/trust/index.md
      - Subject: architecture/modules/subject/index.md
      - Data: architecture/modules/data/index.md
      - Decision: architecture/modules/decision/index.md
      - Federation: architecture/modules/federation/index.md
  - Stack:
    - stack/index.md
    - Backend: stack/backend.md
    - Frontend: stack/frontend.md
    - Data: stack/data.md
    - Auth: stack/auth.md
    - Observability: stack/observability.md
    - Operations: stack/operations.md
    - Deferred: stack/deferred.md
  - Deployments:
    - deployments/index.md
    - Argonne:
      - deployments/argonne/index.md
      - Assets: deployments/argonne/assets.md
    - APS:
      - deployments/aps/index.md
      - Assets: deployments/aps/assets.md
      - Actors: deployments/aps/actors.md
      - Agents: deployments/aps/agents.md
      - Practices: deployments/aps/practices.md
      - Clearances: deployments/aps/clearances.md
      - Supplies: deployments/aps/supplies.md
      - Cautions: deployments/aps/cautions.md
    - 2-BM:
      - deployments/2-bm/index.md
      - Assets: deployments/2-bm/assets.md
      - Calibrations: deployments/2-bm/calibrations.md
      - Actors: deployments/2-bm/actors.md
      - Procedures: deployments/2-bm/procedures.md
      - Subjects: deployments/2-bm/subjects.md
      - Runs: deployments/2-bm/runs.md
      - Campaigns: deployments/2-bm/campaigns.md
      - Cautions: deployments/2-bm/cautions.md
      - Supplies: deployments/2-bm/supplies.md
      - Datasets: deployments/2-bm/datasets.md
      - Decisions: deployments/2-bm/decisions.md
      - Policies: deployments/2-bm/policies.md
    - 35-BM:
      - deployments/35-bm/index.md
  - Catalog:
    - catalog/index.md
    - Capabilities: catalog/capabilities.md
    - Methods: catalog/methods.md
    - Families: catalog/families.md
  - Talks: talks.md
  - Reference:
    - reference/index.md
    - Workflow: reference/workflow.md
    - Layout: reference/layout.md
    - Modeling: reference/modeling.md
    - Affordances: reference/affordances.md
    - Patterns: reference/patterns.md
    - Conventions: reference/conventions.md
    - Runtime: reference/runtime.md
    - Glossary: reference/glossary.md
    - Contributing: reference/contributing.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 2

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/hero-fade.js
  - javascripts/nav-transition.js
  - javascripts/section-reveal.js
  - javascripts/nav-theme.js
  - javascripts/toc-active.js

plugins:
  - search

hooks:
  - scripts/mkdocs_hooks.py

not_in_nav: |
  architecture/modules/_template.md

# Note: contributing.md is staged into docs/ at build time from the repo
# root CONTRIBUTING.md by .github/workflows/docs.yml (see scripts/stage_docs.py).
# For local `mkdocs serve` it is absent and mkdocs will warn; build with
# `make docs-build` to stage it first. index.md is hand-crafted and lives in docs/.
strict: false