docs(wiki): comprehensive codebase wiki rewrite for v2.1.0#135
Merged
Conversation
Expand the single-page HTML wiki from 15 to 30 sections, covering all components, configuration keys, and deployment patterns in detail. New sections: - Per-command CLI reference with all flags and mutual-exclusion rules - Filterable additional_context key table (30+ keys with type/subsystem) - SLURM and K8s preset contents documented with collapsible JSON blocks - Per-launcher config tab panel (torchrun, megatron, torchtitan, deepspeed, vllm, sglang, sglang_disagg, primus) with working context snippets - 8 config recipes: local 1×GPU, local multi-GPU, SLURM single/multi-node, K8s single/multi-node, SGLang Disagg, profiling run - Filterable environment variable tables (read by madengine, set in containers, set by SLURM job script) - Model definition schema (models.json fields with notes) - Build manifest structure with annotated JSON - All 10 error types with when-raised descriptions - Docker build-context section (v2.1.0 feature) - Expanded module reference table (filterable, every source file) - ROCm path resolution chains (host + in-container) - Test markers reference table Updated sections: - Version bumped to v2.1.0 with release date pill - SLURM and K8s deployment sections include full preset merge order - Launcher matrix updated (slurm_multi Local column now ✅) - Changelog restructured with Added/Changed/Fixed headings per version Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
coketaste
requested review from
Cemberk,
Rohan138,
gargrahul and
leconcio
as code owners
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
changes merged into
developsince the wiki was first added (PRs fix: generate MAD_MULTI_NODE_RUNNER for Docker local deployment #126,feat(deployment): add slurm_multi self-managed multi-node SLURM launcher (Revised PR#124) #130, added build-context to docker cmd for ./tools location so various doc… #131, docs: add Docker build-context tools entry to v2.1.0 CHANGELOG #133, fix: guard tools build-context on directory existence and fix SLURM env var escaping #134 / v2.1.0)
additional_contextreference table covering all 30+recognised keys with type, subsystem, and inline examples
context snippets and the full preset merge order for SLURM and Kubernetes
Disagg, and profiling scenarios
New sections
discover,build,run,report,database)additional_contextkey table (filterable)models.jsonfield with gotchasbuild_manifest.jsonJSONslurm_multilauncher--build-context tools=COPY --from=toolsusageadditional_contextsnippets for all 8 launchersUpdated sections
slurm_multiLocal column corrected to ✅ (self-managedvia
ContainerRunner._run_self_managed)Test plan
docs/wiki/index.htmldirectly in a browser (no server needed)additional_context, module reference,environment variables