site_name: YAMS
site_description: Yet Another Memory System — persistent memory for LLMs and applications.
site_url: https://trvon.github.io/yams
repo_url: https://sr.ht/~trvon/yams/
repo_name: sr.ht/~trvon/yams
docs_dir: docs
site_dir: site
use_directory_urls: true

# Exclude internal planning/working docs from site build.
exclude_docs: |
  delivery/**
  pbi/**
  testing/CATCH2_PATTERNS.md
  testing/embedding_dimension_robustness.md
  hosting/p0-object-storage-s3-validation.md
  design/monolith_refactor_program_codex_yams.md

nav:
  - Home: index.md
  - Get Started:
      - Installation: user_guide/installation.md
      - Quick Start: user_guide/README.md
      - CLI Reference: user_guide/cli.md
      - MCP Server: user_guide/mcp.md
  - Guides:
      - Embeddings & Search: user_guide/embeddings.md
      - Self-hosting: hosting/self_hosting.md
      - Operations: admin/operations.md
      - Plugins: PLUGINS.md
      - Prompt Templates: PROMPT.md
  - Reference:
      - API Overview: api/README.md
      - MCP Tools: api/mcp_tools.md
      - System Architecture: architecture/system_architecture.md
      - Benchmarks:
          - Overview: benchmarks/README.md
          - Performance Report: benchmarks/performance_report.md
          - Storage Backends: benchmarks/storage_backends.md
          - LongMemEval_S Baseline: benchmarks/longmemeval_s_baseline.md
      - Developer:
          - Setup: developer/setup.md
          - Build System: developer/build_system.md
          - Contributing: developer/contributing.md
      - Roadmap: roadmap.md

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.top
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: green
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  language: en
  font:
    text: "Outfit"
    code: "JetBrains Mono"
  logo: assets/yams.png
  favicon: assets/yams.png

markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - toc:
      permalink: true
  - footnotes
  - meta
  - sane_lists
  - smarty
  - tables
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search

extra:
  social:
    - icon: simple/sourcehut
      link: https://sr.ht/~trvon/yams/
      name: SourceHut
    - icon: fontawesome/brands/github
      link: https://github.com/trvon/yams
      name: GitHub (mirror)
    - icon: fontawesome/solid/envelope
      link: mailto:support@yamsmemory.ai
      name: Email

extra_css:
  - assets/retro.css
extra_javascript: []
copyright: "© YAMS"