mkdocs.yaml

site_name: LoopX
site_url: https://huangruiteng.github.io/loopx/docs/
repo_url: https://github.com/huangruiteng/loopx
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: output/docs-site
use_directory_urls: true
exclude_docs: |
  /README.md
  archive/**
  book/**
  research/long-horizon-agent-benchmarks/*.json
  showcases/**/*.html
  showcases/showcase-animation-prototype.html
  showcases/showcase-catalog.json

theme:
  name: material
  logo: assets/loopx-logo.png
  favicon: assets/loopx-logo.png
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-2
        name: Switch to system preference
  features:
    - content.action.edit
    - content.code.copy
    - content.tabs.link
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.path
    - search.highlight
    - search.share
    - toc.follow

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_capability_pages.py

hooks:
  - docs/rewrite_capability_links.py

markdown_extensions:
  - attr_list
  - def_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - 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
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - guides/README.md
      - Quick Start: guides/getting-started.md
      - Installation: guides/installing-loopx.md
      - Personal Workspace Guide: guides/personal-workspace-user-guide.md
      - Newcomer Command Path: guides/newcomer-command-path.md
      - Minimal Custom Runtime Example: guides/minimal-custom-runtime-example.md
      - Custom Runner Integration: guides/custom-agent-runner-integration.md
      - Auto Research Stop/Takeover/Wake: guides/auto-research-stop-takeover-wake-walkthrough.md
  - Concepts:
      - concepts/README.md
      - Interaction Patterns: concepts/interaction-pattern-catalog.md
      - Architecture: architecture.md
      - State Interaction Model: state-interaction-model.md
      - Quota Allocation: quota-allocation.md
      - Project Agent Todo Contract: project-agent-todo-contract.md
  - Operations:
      - operations/README.md
      - Attention Queue: operations/attention-queue.md
      - Long Task Cadence: operations/long-task-cadence-policy.md
      - Authority Sources: operations/authority-source-registration.md
      - Status Data Contract: status-data-contract.md
      - Heartbeat Automation Prompt: heartbeat-automation-prompt.md
  - Capabilities:
      - capabilities/README.md
      - Benchmark Toolkit: capabilities/benchmark-toolkit/README.md
      - Issue Fix: capabilities/issue-fix/README.md
      - Change Quality: capabilities/change-quality/README.md
      - Pull Request Review: capabilities/pull-request-review/README.md
      - Integration Branch: capabilities/integration-branch/README.md
      - Project Skill Delivery: capabilities/project-skill-delivery/README.md
      - Explore: capabilities/explore/README.md
      - Decision Context: capabilities/decision-context/README.md
      - Agent Turn Recall: capabilities/agent-turn-recall/README.md
      - Semantic Preference: capabilities/semantic-preference/README.md
      - Reward Memory: capabilities/reward-memory/README.md
      - Material Lifecycle: capabilities/material-lifecycle/README.md
      - Periodic Report: capabilities/periodic-report/README.md
      - Content Operations: capabilities/content-ops/README.md
      - Value Connectors: capabilities/value-connectors/README.md
      - Reliability Diagnostics: capabilities/reliability-diagnostics/README.md
  - Integrations:
      - integrations/README.md
      - Integration Guide: integration.md
      - Worker Bridge: integrations/worker-bridge-install-contract.md
      - Lark Kanban: integrations/lark-kanban-control-plane-adapter.md
      - Botmux Goal Channel Runtime: integrations/botmux-goal-channel-runtime.md
      - Lark Provider: integrations/lark-provider/README.md
      - Runtime Connector Catalog: integrations/runtime-connector-catalog.md
  - Reference:
      - reference/README.md
      - Extensions: reference/extensions.md
      - Benchmark Research RFC: architecture/rfcs/long-horizon-harness-benchmark-research-program-v0.md
      - Protocols: reference/protocols/README.md
      - Contracts: reference/contracts/README.md
  - Development:
      - development/README.md
      - Technical Directions: project/technical-directions.md
      - Testing And Quality: development/testing-and-quality.md
      - Documentation Layout: development/documentation-layout.md
      - Public/Private Boundary: public-private-boundary.md
      - Control Plane Course: development/control-plane-course/README.md
  - Product:
      - product/README.md
      - Vision: product/vision.md
      - Release Readiness: product/release-readiness.md
      - Surfaces: product/surfaces/README.md
      - Runtimes: product/runtimes/README.md
      - Foundations: product/foundations/README.md
  - Showcases:
      - showcases/README.md
      - Frontend Surface: showcases/frontend-surface.md
      - Blocked P0 Safe Rotation: showcases/cases/0617-blocked-p0-safe-rotation.md
      - LoopX Self Iteration: showcases/cases/0619-loopx-self-iteration.md
      - PR Issue Auto Fix: showcases/cases/0624-pr-issue-auto-fix.md