Commit a33ef09
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
File tree
- docs
- deployment
- guides
- guide
- specification
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
73 | | - | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
74 | 75 | | |
75 | 76 | | |
76 | 77 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
169 | 169 | | |
170 | 170 | | |
171 | 171 | | |
172 | | - | |
173 | | - | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
174 | 175 | | |
175 | 176 | | |
176 | 177 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
139 | 169 | | |
140 | 170 | | |
141 | | - | |
142 | | - | |
143 | | - | |
144 | | - | |
145 | | - | |
146 | | - | |
147 | | - | |
148 | | - | |
149 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
150 | 175 | | |
| 176 | + | |
151 | 177 | | |
| 178 | + | |
152 | 179 | | |
153 | 180 | | |
154 | 181 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
| |||
0 commit comments