Skip to content

Conversation

hutm
Copy link
Contributor

@hutm hutm commented Oct 10, 2025

Overview:

docs: removed all TODOs from public facing docs within repo

Summary by CodeRabbit

  • Documentation
    • Cleaned up multi-node backend docs by removing unused TODO subheaders and extra blank lines, improving readability and flow into the Large Model Deployment section.
    • Updated metrics documentation by clarifying the “actual HTTP queue” label (removed footnote marker) and deleting an obsolete TODO footnote about a pending metric.
    • Overall, improves clarity and reduces clutter in docs; no functional, deployment, or metric behavior changes.

@hutm hutm requested a review from a team as a code owner October 10, 2025 01:36
Copy link

copy-pr-bot bot commented Oct 10, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Walkthrough

Removed TODO/footnote elements from two Markdown docs. In vLLM multi-node docs, deleted TODO subsection headers and surrounding blank lines. In metrics README, removed a footnote marker and an inline TODO footnote. No functional or procedural content changed.

Changes

Cohort / File(s) Summary of changes
Documentation cleanup
components/backends/vllm/multi-node.md, deploy/metrics/README.md
Removed "TODO" subsection headers and extra blank lines in vLLM multi-node doc; removed a footnote marker and an inline TODO footnote in metrics README; no content logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I tidied the docs with a hop and a cue,
Snipped little TODOs that no longer grew.
Footnotes departed, whitespace in line—
Carrots of clarity, crisp and fine.
Thump goes my paw: neat burrow, new view! 🥕🐇

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The provided description only fills the Overview section and omits the required Details, Where should the reviewer start, and Related Issues sections specified in the repository template, making the PR description incomplete. Please expand the PR description to include a Details section summarizing the specific changes, a Where should the reviewer start section listing the key files to review, and a Related Issues section referencing any relevant GitHub issue numbers.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title explicitly states the primary change—removal of all TODOs from public-facing documentation—and accurately reflects the modifications made in the PR without unnecessary detail or ambiguity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b640f28 and 44d43c2.

📒 Files selected for processing (2)
  • components/backends/vllm/multi-node.md (0 hunks)
  • deploy/metrics/README.md (1 hunks)
💤 Files with no reviewable changes (1)
  • components/backends/vllm/multi-node.md
⏰ 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 - dynamo

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@hutm hutm force-pushed the mkhadkevich/dyn-1135-removing-all-todos-in-public-facing-docs-within-repo branch from 44d43c2 to b4366d2 Compare October 10, 2025 01:38
@rmccorm4
Copy link
Contributor

Needs merge conflict resolved

@hutm
Copy link
Contributor Author

hutm commented Oct 11, 2025

/ok to test

Copy link

copy-pr-bot bot commented Oct 11, 2025

/ok to test

@hutm, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@hutm
Copy link
Contributor Author

hutm commented Oct 11, 2025

/ok to test b4366d2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants