docs: Refactor README.md and add components/README.md #2141
Conversation
reordered info, cleaned up instructions, added context Signed-off-by: Anish <[email protected]>
WalkthroughThe README.md file was extensively restructured and expanded to enhance clarity and completeness. Sections were reorganized, new headings and tables were introduced, installation and usage instructions were clarified, and formatting was improved throughout. No code or API changes were made; all modifications are strictly documentation-related. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
72-75: Specify a language for fenced code blocks
markdownlint(MD040) flags these blocks because they lack a language tag.
Adding the correct identifier improves syntax highlighting and keeps CI green.-``` +```bash curl -LsSf https://astral.sh/uv/install.sh | shPlease tag all other blocks in the ranges above (
bash,python, etc.).Also applies to: 87-91, 105-107, 126-133, 137-149, 202-208, 214-215, 232-235
201-201: Typo: “prerequites” → “prerequisites”-### Install prerequites +### Install prerequisites
36-36: Tighten wordingThe adverb “exactly” is superfluous and was flagged by LanguageTool.
-This orchestration gap is exactly what NVIDIA Dynamo is built to close. +This orchestration gap is what NVIDIA Dynamo is built to close.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(9 hunks)
🧰 Additional context used
🧠 Learnings (1)
README.md (4)
Learnt from: ptarasiewiczNV
PR: #2027
File: container/deps/vllm/install_vllm.sh:0-0
Timestamp: 2025-07-22T10:22:28.972Z
Learning: The --torch-backend=auto flag works with vLLM installations via uv pip install, even though it's not a standard pip option. This flag is processed by vLLM's build system during installation to automatically match PyTorch distribution with container CUDA versions.
Learnt from: tanmayv25
PR: #1391
File: examples/tensorrt_llm/common/base_engine.py:171-176
Timestamp: 2025-06-05T01:10:51.865Z
Learning: In examples/tensorrt_llm/common/base_engine.py, the _init_engine method is called only once during initialization, so direct mutation of the _default_sampling_params object during setup is safe and appropriate.
Learnt from: nnshah1
PR: #1444
File: tests/fault_tolerance/configs/agg_tp_1_dp_8.yaml:31-38
Timestamp: 2025-07-01T15:33:53.262Z
Learning: In fault tolerance test configurations, the resources section under ServiceArgs specifies resources per individual worker, not total resources for all workers. So workers: 8 with gpu: '1' means 8 workers × 1 GPU each = 8 GPUs total.
Learnt from: julienmancuso
PR: #1365
File: deploy/cloud/operator/api/v1alpha1/dynamocomponentdeployment_types.go:171-178
Timestamp: 2025-06-04T13:09:53.416Z
Learning: The DYN_DEPLOYMENT_CONFIG environment variable (commonconsts.DynamoDeploymentConfigEnvVar) in the Dynamo operator will never be set via ValueFrom (secrets/config maps), only via direct Value assignment. The GetDynamoDeploymentConfig method correctly only checks env.Value for this specific environment variable.
🪛 LanguageTool
README.md
[style] ~36-~36: Consider an alternative for the overused word “exactly”.
Context: ... accelerator? This orchestration gap is exactly what NVIDIA Dynamo is built to close. ...
(EXACTLY_PRECISELY)
[grammar] ~201-~201: Ensure spelling is correct
Context: ...ze=1g --ulimit memlock=-1` ### Install prerequites # Optional step: Only required for Blackwell and Grace Hopper pip3 install torch==2.7.1 torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128 sudo apt-get -y install libopenmpi-dev > [!Tip] > You can learn more about these ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.17.2)
README.md
72-72: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
87-87: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 GitHub Actions: Pre Merge Validation of (ai-dynamo/dynamo/refs/pull/2141/merge) by athreesh.
README.md
[error] 79-79: pre-commit hook 'trailing-whitespace' failed. Trailing whitespace was found and automatically fixed. Run 'pre-commit run --all-files' locally to reproduce.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build and Test - vllm
Signed-off-by: Anish <[email protected]>
rmccorm4
left a comment
rmccorm4
left a comment
There was a problem hiding this comment.
LGTM, needs pre-commit fixed
rmccorm4
changed the title
reordered info, cleaned up instructions, added context. please feel free to leave comments on my ReadME PR. aiming to enable this for the 0.4.0 release
Overview:
Details:
Where should the reviewer start?
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit