Skip to content

Commit a33ef09

Browse files
marevolclaude
andauthored
docs: Reorganize documentation into guide/, specification/, deployment/ (#46)
Restructure docs from 2 categories (guides/, deployment/) into 3 clear categories with consistent depth and coverage: - guide/ (11 files): User-facing tutorials for ML beginners - New: getting-started, projects, data-management, tuning, training, deployment-slots, user-management - Updated: api-keys, inference, ab-testing, retraining (simplified language) - specification/ (7 files): Developer-facing technical reference - New: architecture, data-model, api-reference, websocket-protocol, security-design, inference-service, task-system - deployment/ (8 files): Operations-facing procedural docs - New: management-commands - Moved: standalone-inference from guides/ Also: delete ONE_PAGER.md (absorbed into specification/architecture.md), update README.md doc index, fix all cross-reference links. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 69a3225 commit a33ef09

26 files changed

Lines changed: 5166 additions & 305 deletions

CLAUDE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ helm/recotem/ # Helm chart (ServiceAccount, PDB, NetworkPolicy, HPA)
6969
envs/ # Environment files (dev.env, production.env)
7070
nginx.conf # Proxy config: SPA + /api/ + /ws/ + /admin/ + /inference/ + /static/
7171
docs/
72-
guides/ # Feature guides (inference-api, api-keys, retraining, ab-testing)
73-
deployment/ # Deployment guides (docker-compose, kubernetes, aws, gcp, env vars)
72+
guide/ # User-facing guides (getting started, tuning, training, etc.)
73+
specification/ # Developer-facing specs (architecture, data model, API, security)
74+
deployment/ # Deployment and operations documentation
7475
```
7576

7677
## Development Setup

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,9 @@ recotem/
169169
nginx.conf # SPA + API + WS + Admin + Inference proxy
170170
helm/recotem/ # Helm chart for Kubernetes deployment
171171
docs/
172-
guides/ # Feature guides (inference API, API keys, etc.)
173-
deployment/ # Deployment documentation
172+
guide/ # User-facing guides (getting started, tuning, training, etc.)
173+
specification/ # Developer-facing specs (architecture, data model, API, security)
174+
deployment/ # Deployment and operations documentation
174175
```
175176

176177
## API Development Guide

ONE_PAGER.md

Lines changed: 0 additions & 169 deletions
This file was deleted.

README.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,19 +136,46 @@ cd frontend && npm run type-check # vue-tsc
136136

137137
## Documentation
138138

139+
### User Guide
140+
141+
| Topic | Link |
142+
|-------|------|
143+
| Getting Started | [docs/guide/getting-started.md](docs/guide/getting-started.md) |
144+
| Projects | [docs/guide/projects.md](docs/guide/projects.md) |
145+
| Data Management | [docs/guide/data-management.md](docs/guide/data-management.md) |
146+
| Hyperparameter Tuning | [docs/guide/tuning.md](docs/guide/tuning.md) |
147+
| Model Training | [docs/guide/training.md](docs/guide/training.md) |
148+
| API Keys | [docs/guide/api-keys.md](docs/guide/api-keys.md) |
149+
| Inference API | [docs/guide/inference.md](docs/guide/inference.md) |
150+
| Deployment Slots | [docs/guide/deployment-slots.md](docs/guide/deployment-slots.md) |
151+
| A/B Testing | [docs/guide/ab-testing.md](docs/guide/ab-testing.md) |
152+
| Scheduled Retraining | [docs/guide/retraining.md](docs/guide/retraining.md) |
153+
| User Management | [docs/guide/user-management.md](docs/guide/user-management.md) |
154+
155+
### Specification
156+
157+
| Topic | Link |
158+
|-------|------|
159+
| Architecture | [docs/specification/architecture.md](docs/specification/architecture.md) |
160+
| Data Model | [docs/specification/data-model.md](docs/specification/data-model.md) |
161+
| API Reference | [docs/specification/api-reference.md](docs/specification/api-reference.md) |
162+
| WebSocket Protocol | [docs/specification/websocket-protocol.md](docs/specification/websocket-protocol.md) |
163+
| Security Design | [docs/specification/security-design.md](docs/specification/security-design.md) |
164+
| Inference Service | [docs/specification/inference-service.md](docs/specification/inference-service.md) |
165+
| Task System | [docs/specification/task-system.md](docs/specification/task-system.md) |
166+
167+
### Deployment
168+
139169
| Topic | Link |
140170
|-------|------|
141-
| Inference API | [docs/guides/inference-api.md](docs/guides/inference-api.md) |
142-
| API Key Authentication | [docs/guides/api-keys.md](docs/guides/api-keys.md) |
143-
| Scheduled Retraining | [docs/guides/retraining.md](docs/guides/retraining.md) |
144-
| A/B Testing | [docs/guides/ab-testing.md](docs/guides/ab-testing.md) |
145-
| Standalone Inference | [docs/guides/standalone-inference.md](docs/guides/standalone-inference.md) |
146-
| Docker Compose Deployment | [docs/deployment/docker-compose.md](docs/deployment/docker-compose.md) |
147-
| Kubernetes Deployment | [docs/deployment/kubernetes.md](docs/deployment/kubernetes.md) |
148-
| AWS Deployment | [docs/deployment/aws.md](docs/deployment/aws.md) |
149-
| GCP Deployment | [docs/deployment/gcp.md](docs/deployment/gcp.md) |
171+
| Docker Compose | [docs/deployment/docker-compose.md](docs/deployment/docker-compose.md) |
172+
| Kubernetes | [docs/deployment/kubernetes.md](docs/deployment/kubernetes.md) |
173+
| AWS | [docs/deployment/aws.md](docs/deployment/aws.md) |
174+
| GCP | [docs/deployment/gcp.md](docs/deployment/gcp.md) |
150175
| Environment Variables | [docs/deployment/environment-variables.md](docs/deployment/environment-variables.md) |
176+
| Standalone Inference | [docs/deployment/standalone-inference.md](docs/deployment/standalone-inference.md) |
151177
| Separate Frontend | [docs/deployment/separate-frontend.md](docs/deployment/separate-frontend.md) |
178+
| Management Commands | [docs/deployment/management-commands.md](docs/deployment/management-commands.md) |
152179
| Contributing | [CONTRIBUTING.md](CONTRIBUTING.md) |
153180

154181
## Links

docs/deployment/docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Pre-load models on startup to avoid cold-start latency:
108108
INFERENCE_PRELOAD_MODEL_IDS=1,2,3
109109
```
110110

111-
See [Standalone Inference Guide](../guides/standalone-inference.md) for the full workflow.
111+
See [Standalone Inference Guide](standalone-inference.md) for the full workflow.
112112

113113
## Logs
114114

0 commit comments

Comments
 (0)