docs: Reorganize documentation into guide/, specification/, deployment/#46
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
guides/,deployment/) into 3 clear categories with consistent depth and coverageguide/ — User-facing (11 files, 84 KB)
specification/ — Developer-facing (7 files, 106 KB)
deployment/ — Operations-facing (8 files, 60 KB)
Root files
Test plan
guides/,inference-api.md, orONE_PAGERreferences)docs/guides/directory no longer existsONE_PAGER.mdno longer exists at root🤖 Generated with Claude Code