roboco/mkdocs.yml

# RoboCo documentation site.
# Build:   uv run mkdocs build --strict
# Preview: uv run mkdocs serve
# Deploy:  handled in CI by .github/workflows/docs.yml (mkdocs gh-deploy → gh-pages).
site_name: RoboCo
site_url: https://rennf93.github.io/roboco/
site_description: >-
  RoboCo is a self-hosted AI agentic company — 25 AI agents and one human CEO
  that run as a complete software-development workforce, operated from a single
  control panel.
site_author: Renzo Franceschini
copyright: Copyright © 2026 Renzo Franceschini — licensed under AGPL-3.0

repo_url: https://github.com/rennf93/roboco
repo_name: rennf93/roboco
edit_uri: edit/master/docs/

docs_dir: docs

# Everything under docs/ that is NOT user-facing: the agent-facing RAG corpus,
# the gitignored scratch trees, and the orphaned per-area stubs.
exclude_docs: |
  rag/
  internal/
  superpowers/
  backend/
  frontend/
  ux_ui/
  features/
  bugs/
  initiatives/
  self/
  models/README.md

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - 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

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rennf93/roboco
      name: RoboCo on GitHub
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/watch?v=t1QNqJgBmkM
      name: The RoboCo intro on YouTube

nav:
  - Home: index.md
  - Get Started:
      - get-started/index.md
      - Install & first run: get-started/installation.md
      - Register your first project: get-started/first-project.md
      - Your first task: get-started/first-task.md
  - The Company:
      - company/index.md
      - Org & roles: company/org-and-roles.md
      - The task lifecycle: company/task-lifecycle.md
      - The merge model: company/merge-model.md
      - MegaTask — batched, sequenced work: company/megatask.md
      - How agents are sandboxed: company/agent-gateway.md
  - The Tour:
      - how-to/README.md
      - The shape of the company: how-to/01-the-company.md
      - It starts with you: how-to/02-it-starts-with-you.md
      - The cells build it: how-to/03-the-cells-build-it.md
      - The last call — and the loop: how-to/04-the-last-call-and-the-loop.md
      - The business workflow: how-to/05-the-business-workflow.md
  - Operating the Panel:
      - panel/index.md
      - Command Center: panel/command-center.md
      - Tasks & Kanban: panel/tasks-and-kanban.md
      - Agents & Work Sessions: panel/agents-and-work-sessions.md
      - Git: panel/git.md
      - Knowledge Base: panel/knowledge-base.md
      - Projects & Products: panel/projects-and-products.md
      - Communications & Journals: panel/communications-and-journals.md
      - Auditor: panel/auditor.md
      - Business: panel/business.md
      - Metrics: panel/metrics.md
      - Settings: panel/settings.md
  - Choosing & Running Models:
      - models/index.md
      - Provider routing: models/provider-routing.md
      - Running on Grok: models/grok.md
      - Resilience: models/resilience.md
  - Cost & Observability:
      - operations/index.md
      - Cost & usage: operations/cost-and-usage.md
      - Health & metrics: operations/health-and-metrics.md
  - Optional Subsystems:
      - optional/index.md
      - Architectural Conventions: optional/conventions.md
      - Toolchain matching: optional/toolchain-matching.md
      - Web research: optional/web-research.md
      - Strategy engine: optional/strategy-engine.md
      - Pitch provisioning: optional/pitch-provisioning.md
      - External / internal PR review: optional/pr-review.md
      - Self-healing CI: optional/self-heal.md
      - Autonomous maintenance: optional/autonomous-maintenance.md
  - Configure & Deploy:
      - deploy/index.md
      - Deployment: deploy/deployment.md
      - Environment reference: deploy/env-reference.md
      - Data & migrations: deploy/data-and-migrations.md
      - Bootstrap & seeds: deploy/bootstrap-and-seeds.md
  - API Reference:
      - api/index.md
      - REST API: api/rest-api.md
      - WebSocket streams: api/websockets.md
      - Authentication: api/auth.md
  - Troubleshooting & Security:
      - troubleshooting/index.md
      - Common issues: troubleshooting/common-issues.md
      - Security: troubleshooting/security.md