Files
roboco/docs/optional/index.md
T
Renn F 2fb63fed1f docs: add the user-facing MkDocs documentation site
Build a complete user-facing documentation site (MkDocs Material) under docs/, served at roboco.dev/docs via a new gh-pages deploy workflow.

- Sections: Get Started, The Company, the Tour, Operating the Panel, Choosing & Running Models, Cost & Observability, Optional Subsystems, Configure & Deploy, API Reference, Troubleshooting & Security (55 pages).
- mkdocs.yml (Material theme; excludes the agent-facing rag/ corpus, internal scratch, and orphaned stub trees) and .github/workflows/docs.yml (mkdocs gh-deploy to gh-pages).
- Retire the stale root usage.md and deployment.md to redirect stubs into the site.
- Fix the docs tooling: add the pymarkdownlnt dependency + .pymarkdown.json, run serve-docs/lint-docs/fix-docs under the docs extra, add a build-docs strict gate.
- Fix the roboco console-script entry point (cli, not the un-awaited async main).
- README: correct the project-structure tree (optimal.py, alembic) and link the docs site.
2026-06-22 15:53:00 +02:00

2.5 KiB

Optional subsystems

Beyond the core delivery loop, RoboCo ships a set of optional engines — most off by default — that you turn on when you want them. They're the "company-in-a-box" capabilities and the stricter quality gates. This page is the reference for all of them; each has its own page below.

The Feature Flags card

You toggle these from Settings → Feature Flags in the panel rather than hand-editing environment variables. A toggle persists in the settings store and takes effect on the next backend restart. The matching ROBOCO_* environment variable is the same switch at the source — an unset flag falls back to its environment/config default, and some flags carry extra configuration (an API key, a project slug) that only lives in the environment.

!!! info "The restart contract" Flipping a flag in the panel saves it immediately, but the subsystem it controls is wired up at startup — so the change lands on the next backend restart, not instantly.

What you can turn on

Subsystem Flag Default What it does
Architectural Conventions ROBOCO_CONVENTIONS_ENABLED off Per-project rules for where code lives; hard-gates agents from misplaced code and lint suppressions.
Toolchain matching ROBOCO_TOOLCHAIN_MATCH_ENABLED off (on in the personal compose) Builds each project under its own declared Python and blocks gates when the suite can't run.
Web research ROBOCO_RESEARCH_ENABLED off Gives Board/PM agents gated web search & fetch through a provider you supply.
Strategy engine ROBOCO_STRATEGY_ENGINE_ENABLED off Notify-only nudges when the company drifts, goes idle, or stalls.
Pitch provisioning ROBOCO_PROVISIONING_TOKEN (+ org) inert until set On pitch approval, auto-creates repos and seeds a build task.
External / internal PR review ROBOCO_EXTERNAL_PR_ENABLED / ROBOCO_INTERNAL_PR_ENABLED off Reviews inbound external/fork PRs and untied org-repo PRs.
Self-healing CI ROBOCO_SELF_HEAL_ENABLED (+ originate) off Watches RoboCo's own CI and, optionally, queues a CEO-gated fix task.

!!! note "Always-on resilience" Provider overload parking (ROBOCO_OVERLOAD_BREAK_ENABLED) is on by default — it's not something you enable, it's a safety net. See Resilience.