mkdocs.yml

site_name: Mewbo
site_description: Documentation for Mewbo — an AI assistant modeled as a conversation state machine with a hierarchical agent hypervisor. Accessible via CLI, web console, REST API, and Home Assistant.
repo_url: https://github.com/bearlike/Assistant
repo_name: bearlike/Assistant
site_url: https://docs.mewbo.com/

theme:
  name: shadcn
  favicon: logos/favicon.ico
  icon: logos/logo-transparent.svg

  # Header tab rail (theme >= 1.3.0): fused below the top utility row, one
  # sticky surface. The API Reference tab lands on the full-page Scalar app
  # (docs/rest-api.md, rendered via the theme's app.html template).
  header_tabs:
    - label: Documentation
      icon: lucide:book-open
      url: .
    - label: API Reference
      icon: lucide:braces
      url: rest-api/

  # Mewbo brand-fork (mkdocs-shadcn-mewbo) configuration ────────────────
  ai:
    deepwiki_repo: bearlike/Assistant
    question_prefix: |
      I'm a new user; give product-first, well-grounded answers.
    examples:
      - "How do I install and configure Mewbo?"
      - "How does the agent hypervisor work?"
      - "How do I add MCP tools?"
      - "How do I connect Home Assistant?"
  # Code-reference badges (theme >= 1.4.0): authors write `repo:`/`endpoint:`
  # link schemes and the theme rewrites them into DeepWiki-style badges. File
  # badges auto-derive from repo_url (GitHub blob at the build SHA); endpoint
  # badges deep-link into the Scalar reference page below. The tags map MUST
  # stay in sync with RETAG_RULES in scripts/ci/generate_openapi_spec.py.
  code_refs:
    endpoint:
      reference_page: rest-api/
      tags:
        /api/sessions: Sessions
        /api/query: Sessions
        /api/commands: Sessions
        /api/share: Sessions
        /api/projects: Projects & Worktrees
        /api/v_projects: Projects & Worktrees
        /api/keys: API Keys
        /api/models: Models
        /api/tools: Tools & Skills
        /api/skills: Tools & Skills
        /api/plugins: Plugins
        /api/notifications: Notifications
        /api/config: Configuration
        /api/agentic_search/workspaces: Workspaces & Runs
        /api/agentic_search/runs: Workspaces & Runs
        /api/agentic_search/sources: Source Graph
        /api/agentic_search/scg: Source Graph
        /v1/structured: Structured Outputs
        /v1/draft: Draft Streaming
        /v1/wiki: Wiki Ingestion
        /api/automation: Automation
  versions_root: Assistant
  show_version_switcher: true
  show_build_info: true
  # Hero product-tour carousel: the theme emits Swiper (CDN) + its SRI-hashed
  # init and styles `.ms-shots`; the landing page only writes the
  # `.swiper.ms-shots` markup (no local CSS/JS, no extra_css/extra_javascript).
  carousel: true
  # Footer "Connect" column: GitHub is auto-filled from repo_url; the email
  # button is appended right after it (the theme ships an email→lucide:mail alias).
  footer:
    social:
      email: mailto:hello@mewbo.com
  nav_icons:
    Home: lucide:house
    "Get Started": lucide:rocket
    Troubleshooting: lucide:life-buoy

    Configure: lucide:sliders-horizontal
    "LLM Setup": lucide:brain
    "Project Setup": lucide:folder-cog
    "Configuration Reference": lucide:file-json

    Use: lucide:monitor-play
    CLI: lucide:terminal
    "Web Console + API": lucide:layout-dashboard
    "MCP Server": lucide:plug-zap
    "Home Assistant": lucide:house-plug
    "Nextcloud Talk": lucide:message-circle
    Email: lucide:mail
    "CI Agent Pickup": lucide:bot

    Capabilities: lucide:sparkles
    "Workspace & Execution": lucide:hammer
    "Built-in Tools": lucide:wrench
    "Branches & Worktrees": lucide:git-fork
    "Web IDE": lucide:code-xml
    Widgets: lucide:panel-left
    "Code Intelligence": lucide:zap
    "External Tools (MCP)": lucide:plug
    "Knowledge & Discovery": lucide:library
    "Agentic Wiki": lucide:book-marked
    "Agentic Search": lucide:search
    "Structured Outputs": lucide:brackets
    "Composition & Delegation": lucide:users
    "Sub-agents": lucide:git-branch
    Skills: lucide:graduation-cap
    "Plugins & Marketplace": lucide:puzzle
    "Control & Safety": lucide:shield
    "Plan Mode": lucide:clipboard-list
    "Permissions & Hooks": lucide:lock
    Policies: lucide:shield-check
    Monitors: lucide:eye
    "Session & Context": lucide:clock
    "Token Usage": lucide:coins
    Compaction: lucide:archive

    Deploy: lucide:package
    "Docker Compose": lucide:container
    "Storage Backends": lucide:database
    "Production Setup": lucide:server

    Develop: lucide:code
    "Architecture Overview": lucide:blocks
    "Session Runtime": lucide:cpu
    "Building a Client": lucide:hammer
    "REST API": lucide:globe
    "Python Reference": lucide:book-open-text

hooks:
  - docs/hooks/schema_to_md.py

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
      linenums: false
      css_class: codehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

exclude_docs: |
  superpowers/
  hooks/
  CLAUDE.md

plugins:
  - search
  - callouts:
      aliases: false
  - mkdocstrings:
      handlers:
        python:
          paths:
            - .
            - apps
            - packages/mewbo_core/src
            - packages/mewbo_tools/src
            - packages/mewbo_graph/src
            - apps/mewbo_api/src
            - apps/mewbo_cli/src
          options:
            docstring_style: google
            show_source: true
            show_signature_annotations: true
            show_root_heading: true
            show_root_toc_entry: false

extra:
  version:
    provider: mike

# Theme ships everything that used to live in extra_css/extra_javascript and
# overrides/ — including the hero product-tour carousel (theme.carousel above
# emits Swiper + its init and styles `.ms-shots`). If you ever need to override
# theme behavior again, you can add `theme.custom_dir: overrides`, but the brand
# chrome / Ask AI / nav icons / version switcher / SEO / speculation prefetch /
# build-info badge are all already provided.

nav:
  - Home: index.md
  - Get Started: getting-started.md
  - Configure:
      - LLM Setup: llm-setup.md
      - Project Setup: project-configuration.md
      - Configuration Reference: configuration.md
  - Use:
      - CLI: clients-cli.md
      - Web Console + API: clients-web-api.md
      - MCP Server: clients-mcp.md
      - Home Assistant: clients-home-assistant.md
      - Nextcloud Talk: clients-nextcloud-talk.md
      - Email: clients-email.md
      - CI Agent Pickup: ci-agent-pickup.md
  - Knowledge & Discovery:
      - Agentic Wiki: features-wiki.md
      - Agentic Search: features-search.md
      - Structured Outputs: features-structured-outputs.md
  - Capabilities:
      - Workspace & Execution:
          - Built-in Tools: features-builtin-tools.md
          - Branches & Worktrees: features-worktrees.md
          - Web IDE: features-web-ide.md
          - Widgets: features-widgets.md
          - Code Intelligence: features-lsp.md
          - External Tools (MCP): features-mcp.md
      - Composition & Delegation:
          - Sub-agents: features-agents.md
          - Skills: features-skills.md
          - Plugins & Marketplace: features-plugins.md
      - Control & Safety:
          - Plan Mode: features-plan-mode.md
          - Permissions & Hooks: features-permissions-hooks.md
          - Policies: features-policies.md
          - Monitors: features-monitors.md
      - Session & Context:
          - Token Usage: features-token-usage.md
          - Compaction: features-compaction.md
  - Deploy:
      - Docker Compose: deployment-docker.md
      - Storage Backends: deployment-storage.md
      - Production Setup: deployment-production.md
  - Develop:
      - Architecture Overview: core-orchestration.md
      - Session Runtime: session-runtime.md
      - Building a Client: developer-guide.md
      - REST API: rest-api.md
      - Python Reference: reference.md
  - Troubleshooting: troubleshooting.md