This is the main docs index for users, contributors, and operators.
Current Status First
If you need to know what is shipped vs still in progress:
Quick Paths By Audience
- New user/operator setup: User guide
- Contributor/developer workflows: Developer guide
- Runtime/system model: Architecture
Task-Based Navigation
- Install, sync configs, run daemon/HUD: User guide
- Build/reload loop for local development: Development build lifecycle
- Add or update MCP servers safely: Developer guide
- Manage repository branding through MCP:
mcp-brand-kitprovides repository listing, inspection, lint, preview, render, and fix tools. - Understand compatibility commitments: API stability
- Follow MCP error-handling standards: Error handling
- Respond to Mills dependency and CI signature incidents: External incident runbook
- Configure enterprise controls: Enterprise security
- Configure remote transport: Streamable HTTP
- Mobile companion API contract (draft): Mobile companion API
- Mobile companion security model (draft): Mobile companion security
- Mobile companion iPhone test runbook: iPhone testing
- Mobile companion signing and CI secrets setup: Mobile companion signing setup
- Follow docs ownership and update cadence: Documentation maintenance
- Publish docs to flexinfer.ai: Flexinfer site integration
Planning and Technical Direction
- Active roadmap and priorities: Roadmap
- Planning index and historical notes: Planning index
Documentation Checks
Run the standalone documentation lint before opening a change that touches documentation or contributor-facing scripts:
scripts/docs-lint.sh
The lint runs the same changed-files documentation policy used in CI and checks
that every status shown in the planning index matches that plan's
> **Status:** ... annotation. Keep planning documents as the source of truth:
when a plan status changes, update its index row in the same change. The output
identifies the index file and line, plus the mismatched status, so stale entries
can be corrected directly.
Diagrams
- Diagram sources and regeneration notes: Diagrams