Skip to content

WIP chore: refactor docs into structured sections#2022

Open
samsja wants to merge 1 commit intomainfrom
chore/refactor-docs
Open

WIP chore: refactor docs into structured sections#2022
samsja wants to merge 1 commit intomainfrom
chore/refactor-docs

Conversation

@samsja
Copy link
Member

@samsja samsja commented Mar 12, 2026

Summary

  • Reorganize flat docs into 5 main sections: Getting Started, Architecture, Performance, Single Node, Multi Node
  • Port all existing content from 15 flat files into the new structure
  • Update mint.json navigation to reflect new organization
  • Add placeholder pages for performance topics (MoE, CP, memory efficiency) to be filled in later

Structure

docs/
├── getting-started/     (installation, quickstart, config-system, development)
├── architecture/        (overview, orchestrator, trainer, inference, environments,
│                         trajectories, checkpointing, pipeline-rl, async-rl)
├── performance/         (overview, moe, context-parallelism, memory-efficiency,
│                         distributed-inference, benchmarking)
├── single-node/         (overview, sft, rl, lora, distillation, multimodal)
├── multi-node/          (overview, slurm, kubernetes, sft, rl)
└── top-level            (supported-models, custom-algorithms, metrics, logging, troubleshooting)

Test plan

  • Verify mint.json renders correctly on Mintlify
  • Check all internal links resolve
  • Review content completeness in each section

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only reorganization; main risk is broken internal links/asset paths or missing content during the move.

Overview
Restructures docs into a new hierarchy under getting-started/, architecture/, performance/, single-node/, and multi-node/, including new overview/entrypoint pages (e.g. docs/index.md, architecture/overview.md) and placeholder performance topics.

Removes and relocates prior flat docs (notably deployment.md, entrypoints.md, kubernetes.md, multi_run_manager.md) into the new sectioned pages (e.g. multi-node/kubernetes.md, single-node/lora.md, single-node/rl.md) and updates links/assets paths and a handful of wording/typo fixes.

Updates Mintlify navigation in docs/mint.json to match the new structure and page locations.

Written by Cursor Bugbot for commit 59dd18b. This will update automatically on new commits. Configure here.

Reorganize flat docs into getting-started, architecture, performance,
single-node, and multi-node sections. Port all existing content into
the new structure and update mint.json navigation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@samsja samsja changed the title chore: refactor docs into structured sections WIP chore: refactor docs into structured sections Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant