mkdocs.yml

site_name: "RLM Code \U0001F9EA"
site_description: "\U0001F680 Research Playground & Evaluation OS for Recursive Language Model Agentic Systems"
site_author: Shashi Jagtap
site_url: https://superagenticai.github.io/rlm-code/

repo_name: SuperagenticAI/rlm-code
repo_url: https://github.com/SuperagenticAI/rlm-code

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: "\u2600\uFE0F Switch to light mode"
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: "\U0001F319 Switch to dark mode"
  font:
    text: Inter
    code: Fira Code
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: assets/logo.png
  favicon: assets/favicon.png

copyright: >
  Brought to You by <a href="https://super-agentic.ai" target="_blank" rel="noopener">Superagentic AI</a>

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

plugins:
  - search
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SuperagenticAI/rlm-code
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/rlm-code/
  generator: false

extra_css:
  - stylesheets/extra.css

nav:
  - "\U0001F3E0 Home": index.md
  - "\U0001F680 Getting Started":
    - getting-started/index.md
    - "\U0001F9ED Start Here": getting-started/start-here.md
    - "\U0001F4E6 Installation": getting-started/installation.md
    - "\u26A1 Quick Start": getting-started/quickstart.md
    - "\U0001F9EA CodeMode Quickstart": getting-started/codemode-quickstart.md
    - "\U0001F9D1\U0001F52C Researcher Onboarding": getting-started/researcher-onboarding.md
    - "\U0001F4BB CLI Reference": getting-started/cli.md
    - "\u2699\uFE0F Configuration": getting-started/configuration.md
  - "\U0001F9EA CodeMode":
    - codemode/index.md
    - "\u26A1 Quickstart": codemode/quickstart.md
    - "\U0001F527 UTCP (Local)": codemode/utcp.md
    - "\u2601\uFE0F Cloudflare (Remote)": codemode/cloudflare.md
    - "\U0001F3D7\uFE0F Architecture": codemode/architecture.md
    - "\U0001F6E1\uFE0F Guardrails": codemode/guardrails.md
    - "\u2696\uFE0F Evaluation": codemode/evaluation.md
  - "\U0001F9E0 Core Engine":
    - core/index.md
    - "\U0001F504 RLM Runner": core/runner.md
    - "\U0001F30D Environments": core/environments.md
    - "\U0001F9ED Execution Patterns": core/execution-patterns.md
    - "\U0001F4E1 Event System": core/events.md
    - "\U0001F6D1 Termination": core/termination.md
    - "\U0001F9F9 Memory Compaction": core/memory-compaction.md
    - "\U0001F4DF REPL Types": core/repl-types.md
    - "\U0001F4C8 Trajectory": core/trajectory.md
    - "\U0001F504 Paradigm Comparison": core/comparison.md
  - "\U0001F3AF Policies & Safety":
    - policies/index.md
    - "\U0001F3C6 Reward Policies": policies/reward.md
    - "\U0001F3AF Action Selection": policies/action-selection.md
    - "\U0001F9F9 Compaction": policies/compaction.md
    - "\U0001F6D1 Termination": policies/termination.md
    - "\U0001F4DA Registry": policies/registry.md
    - "\U0001F512 HITL & Approval":
      - security/index.md
      - "\U0001F512 Approval Gates": security/approval-gates.md
      - "\U0001F6E1\uFE0F CodeMode Guardrails": security/codemode-guardrails.md
      - "\u26A0\uFE0F Risk Assessment": security/risk-assessment.md
      - "\U0001F4DD Audit Logging": security/audit.md
  - "\U0001F5A5\uFE0F Terminal UI":
    - tui/index.md
    - "\U0001F4CB Tab Reference": tui/tabs.md
    - "\U0001F52C Research Tab": tui/research.md
    - "\U0001F9E9 Widgets": tui/widgets.md
    - "\U0001F3A8 Theme System": tui/theme.md
  - "\U0001F4CA Benchmarks & Replay":
    - benchmarks/index.md
    - "\U0001F3C1 Presets": benchmarks/presets.md
    - "\U0001F3C6 Leaderboard": benchmarks/leaderboard.md
    - "\u2696\uFE0F CodeMode Evaluation": benchmarks/codemode-evaluation.md
    - "\u23EA Session Replay": benchmarks/session-replay.md
  - "\U0001F50D Observability":
    - observability/index.md
    - "\U0001F4E5 Sink Architecture": observability/sinks.md
    - "\U0001F4CA MLflow": observability/mlflow.md
    - "\U0001F4E1 OpenTelemetry": observability/otel.md
    - "\U0001F517 LangSmith": observability/langsmith.md
    - "\U0001F517 LangFuse": observability/langfuse.md
    - "\U0001F525 Logfire": observability/logfire.md
  - "\U0001F4E6 Platform":
    - "\U0001F4E6 Sandbox Runtimes":
      - sandbox/index.md
      - "\U0001F4BB Local": sandbox/local.md
      - "\U0001F9E6 Monty": sandbox/monty.md
      - "\U0001F433 Docker": sandbox/docker.md
      - "\u2601\uFE0F Cloud": sandbox/cloud.md
    - "\U0001F517 Integrations":
      - integrations/index.md
      - "\U0001F916 LLM Providers": integrations/llm-providers.md
      - "\U0001F50C MCP Server": integrations/mcp.md
      - "\U0001F9EA CodeMode Integration": integrations/codemode.md
      - "\U0001F9E9 Frameworks": integrations/frameworks.md
  - "\U0001F4D6 Reference":
    - reference/index.md