Documentation
Documentation
Everything you need to install, configure, run and extend Overseer. Start with the Quick Start, or jump to a topic in the sidebar.
Where to start
New to Overseer? Read these in order:
- Requirements · what you need on the machine.
- Installation · clone, set up and install.
- Quick Start · run the backend and open the console.
- Configuration · tune models and behaviour.
Reference
- CLI · commands and scripts.
- Project Structure · how the repository is laid out.
- Models · the full AI model catalogue.
- Pipeline · the 13-stage processing flow.
- API Reference · REST and WebSocket contract.
- Examples · end-to-end workflows.
Contributing
Overseer is MIT licensed and developed in the open. See Contributing and the License.
Docs are Markdown
Every page under website/src/docs/ is a Markdown file with front matter (title, order). Add one and it appears in this sidebar automatically.