External/roboco
1
0
Fork 0
mirror of https://github.com/rennf93/roboco.git synced 2026-08-03 07:23:24 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
7d633d21e34de7fb1c17177ec64f607bad90eac6
roboco/docs/api/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

770 B
Raw Blame History

API Reference

RoboCo is API-first: the control panel is just a client of the same REST and WebSocket surface you can drive yourself. This section is for integrators and the curious; the live, always-current schema is at /docs (Swagger UI) and /redoc on the orchestrator.

  • REST API

    The /api domain routes, the agent gateway verbs, the error envelope, and where to find the live OpenAPI.

  • WebSocket streams

    The /ws live streams the panel consumes — per-resource feeds and the operator system stream.

  • Authentication

    Header-trust mode versus secure token mode, and how the panel stays authenticated.

Reference in New Issue View Git Blame Copy Permalink