mkdocs.yml

site_name: ragweld Docs
site_description: Open-source API-first MLOps Engineering Platform for retrieval and agent systems
site_url: https://dmontgomery40.github.io/ragweld/
repo_url: https://github.com/DMontgomery40/ragweld
repo_name: DMontgomery40/ragweld
edit_uri: edit/main/mkdocs/docs/
copyright: Copyright © 2026 ragweld
docs_dir: mkdocs/docs

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - toc.integrate
    - header.autohide
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
    - search.share
  icon:
    logo: material/vector-combine
    repo: fontawesome/brands/github
    admonition:
      note: material/note-text
      info: material/information
      tip: material/lightbulb
      success: material/check-circle
      warning: material/alert
      danger: material/alert-circle

plugins:
  - search
  - mike
  - git-revision-date-localized:
      enable_creation_date: true
      type: iso_datetime
      strict: false
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
  - glightbox

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DMontgomery40/ragweld
  version:
    provider: mike
    default: latest

extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - assets/js/mermaid-init.js

nav:
  - Home: index.md
  - User Manual:
      - Overview: manual/index.md
      - Quickstart: manual/quickstart.md
      - Native Postgres (macOS): manual/native_postgres.md
      - Indexing a corpus: manual/indexing.md
      - Searching & answering: manual/search.md
      - Source document viewer: manual/source_viewer.md
      - Web search in Chat: manual/web_search.md
      - UI tour: manual/ui.md
      - Troubleshooting: manual/troubleshooting.md
  - Concepts:
      - Architecture: architecture.md
      - Retrieval overview: retrieval/overview.md
      - Indexing pipeline: indexing.md
      - Corpus vs repo_id: guides/corpus.md
      - Evaluation guide: eval_guide.md
      - Synthetic Data Lab: guides/synthetic_lab.md
      - Figure grounding eval: guides/eval_figure_grounding.md
  - Reference:
      - Configuration: configuration.md
      - API: api.md
      - Models: models.md
      - Glossary: glossary.md
  - Operations:
      - Deployment: deployment.md
      - Operations & metrics: operations.md
      - Docker services UI: operations/docker_ui.md
      - Production scope & links: operations/production_scope.md
      - Tracing: operations/tracing.md
      - Startup & lifecycle: operations/lifecycle.md
      - Startup cancellation & unwind: operations/cancellation.md
      - Postgres schema modes: operations/postgres.md
      - MLX chat model lifecycle: operations/mlx.md
      - Codex exec automation (cron lanes): operations/codex_exec.md
      - MLX reranker idle-unload: operations/mlx_idle_unload.md
      - Alert webhooks: operations/webhooks.md
      - Security: security.md
      - Troubleshooting: troubleshooting.md
  - Developer:
      - Dev workflow: dev_workflow.md
      - Docs Autopilot: dev/docs-autopilot.md
      - Docs Autopilot workflow: dev/docs-autopilot-workflow.md
      - Docs Autopilot (CI soft-fail updates): dev/docs-autopilot-ci.md
      - Pydantic: dev/pydantic.md
      - Config store & caching: dev/config_store.md
      - Config cache & locks: dev/config_cache_locks.md
      - Acceptance smoke test: dev/acceptance_epstein.md
      - Frontend: frontend.md
      - Testing: testing.md
      - Observability: observability.md