docs: rewrite README as concise landing page and add architecture diagrams [WIP]#161
Draft
coketaste wants to merge 1 commit into
Draft
docs: rewrite README as concise landing page and add architecture diagrams [WIP]#161coketaste wants to merge 1 commit into
coketaste wants to merge 1 commit into
Conversation
…ures Trim root README from 707 to 258 lines by moving deep reference material (profiling tables, extended config/usage recipes, tips) into docs/ and linking out. Replace the ASCII architecture block and the stale, unreferenced docs/img PNGs with accurate inline Mermaid figures for the layered architecture, build->run->report pipeline, and deployment-target inference. Move the parallelism/infrastructure capability matrices into docs/launchers.md and add Mermaid workflow diagrams to docs/deployment.md and docs/README.md. Co-Authored-By: Claude <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
README.mdas a concise landing page, replacing the long-form content with a tighter overview (734 → much shorter, ~460 net removed)docs/README.md(CLI → orchestration → execution/deployment → launcher flow) anddocs/deployment.md(build/deploy workflow and target-inferencedecision tree), replacing ASCII-art diagrams
docs/launchers.md: per-launcher parallelism support (TP/PP/DP/CP/FSDP/EP) and per-target infrastructure features (local/K8s/SLURM)docs/img/architecture_overview.pnganddocs/img/distributed_workflow.png(superseded by inline Mermaid diagrams)Test plan
README.md,docs/README.md,docs/deployment.md, anddocs/launchers.mdon GitHub (or a Markdown/Mermaid previewer) to confirm diagrams and tables render correctly