🎯 [EPIC] Documentation for Geti Inspect #3238
Description
Describe the epic
Add documentation for Geti Inspect
The final doc will be served using Docusaurus
Goals
- Getting Started
- Installation
- Quick start tutorial
- How to guide
- Concepts
- Architecture
- Deeplearning concepts
- API references
- REST API
Tasks
Geti Inspect docs
- Create Docusaurus site at repo root (
/docs+ config) / or consider migrating current documentation to Docusaurus - Configure site basics: title/branding, navbar, footer, sidebar, edit links
- Configure docs tooling: versioning (if needed), search, syntax highlighting
- Add contribution guide: style guide, templates, how to add pages, preview instructions
Getting Started
- Installation: prerequisites, supported platforms, install options, verify install
- Quick start tutorial: minimal end-to-end run, expected outputs, screenshots
- Quick start troubleshooting: common setup/runtime issues
How-to guides
- Small workflow with camera (baseline workflow)
- Tune configuration/parameters
- Interpret results (scores, thresholds, metrics)
- Integrate via REST API (auth, examples, error handling)
- Deploy/run in production (container/service patterns, env vars)
- Debug issues (logs, reproducibility)
Concepts
- Architecture: components + data flow diagram
- Training/job lifecycle concepts: artifacts, storage, states
- Deep learning concepts: anomaly detection basics, calibration, evaluation metrics
- Data concepts: formats, splits, labeling expectations
API reference (REST)
- Inventory endpoints: purpose, auth, requests/responses, status codes
- Generate/confirm OpenAPI spec (source of truth)
- Render REST API docs in Docusaurus (OpenAPI plugin or markdown)
- Document error model: error codes, validation, retries/rate limits (if applicable)
Quality & publishing
- Add assets & examples: sample payloads/configs, consistent screenshots
- Cross-linking: glossary, “next steps”, related pages
- Validation: link check, snippet accuracy, spellcheck (optional)
- CI build + deploy: PR previews + main publish target (e.g., GitHub Pages/internal)