Skip to content

docs: update introduction page with links and formatting#7330

Merged
nealvaidya merged 3 commits into
mainfrom
dagil-nvidia/docs-intro-updates
Mar 13, 2026
Merged

docs: update introduction page with links and formatting#7330
nealvaidya merged 3 commits into
mainfrom
dagil-nvidia/docs-intro-updates

Conversation

@dagil-nvidia
Copy link
Copy Markdown
Collaborator

@dagil-nvidia dagil-nvidia commented Mar 13, 2026

Summary

  • Add "open-source" to the opening description of Dynamo
  • Add GitHub links for NIXL, Grove, and AIConfigurator in the ecosystem table
  • Apply title case to performance composability lead-ins
  • Fix "KV cache-aware" hyphenation consistency
  • Update page title to "Introduction to Dynamo"

Test Plan

  • CI passes
  • Fern docs preview renders correctly
  • Links to NIXL, Grove, and AIConfigurator repos resolve

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Updated introduction page title and metadata for improved clarity
    • Enhanced description to emphasize open-source nature and distributed environment context
    • Added links to related components and resources
    • Improved formatting consistency with standardized headings and terminology

- Add "open-source" to opening description
- Add GitHub links for NIXL, Grove, and AIConfigurator in ecosystem table
- Apply title case to performance composability lead-ins
- Fix "KV cache-aware" hyphenation in image alt text and lead-ins
- Update page title to "Introduction to Dynamo"

Signed-off-by: Dan Gil <dagil@nvidia.com>
Made-with: Cursor
@github-actions github-actions Bot added docs documentation Improvements or additions to documentation labels Mar 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 13, 2026

Walkthrough

Documentation page metadata and content updates including title changes, hyperlink additions for components (Grove, AIConfigurator, NIXL), consistent hyphenation improvements (e.g., "KV cache-aware routing"), and standardized section title phrasing across the introduction page.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/getting-started/introduction.md
Updated page title and metadata, added hyperlinks for Grove, AIConfigurator, and NIXL components, improved hyphenation consistency ("KV cache-aware routing"), and standardized section titles and capitalization.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit hops through docs so fine,
Adding links with a deft design,
Hyphens placed with care and grace,
Grove and NIXL find their place!
Introduction shines anew,
Clearer paths for all to view! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description includes a clear summary of changes and test plan but lacks the full template structure with Overview, Details, Where should the reviewer start, and Related Issues sections. Reorganize the description to match the template structure: add an Overview section, expand Details section, specify files to review, and add Related Issues section with any applicable GitHub issue numbers.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: update introduction page with links and formatting' accurately summarizes the main changes: documentation updates to the introduction page with added links and formatting improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use OpenGrep to find security vulnerabilities and bugs across 17+ programming languages.

OpenGrep is compatible with Semgrep configurations. Add an opengrep.yml or semgrep.yml configuration file to your project to enable OpenGrep analysis.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/getting-started/introduction.md (1)

156-156: ⚠️ Potential issue | 🟡 Minor

Fix hyphenation inconsistency in link text.

The link text should use "KV Cache-Aware Routing" for consistency with the rest of the document.

📝 Proposed fix
-- [KV Cache Aware Routing](../components/router/router-guide.md) -- Configure smart request routing
+- [KV Cache-Aware Routing](../components/router/router-guide.md) -- Configure smart request routing
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/getting-started/introduction.md` at line 156, Update the link text token
"[KV Cache Aware Routing]" to use the hyphenated form "[KV Cache-Aware Routing]"
so it matches the rest of the document; locate the markdown link line containing
"KV Cache Aware Routing" and replace the visible link text only (not the URL)
with "KV Cache-Aware Routing".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/getting-started/introduction.md`:
- Line 99: Replace the inconsistent phrase "KV cache aware routing" with the
hyphenated form "KV cache-aware routing" wherever it appears (specifically
update the occurrence in the sentence that currently reads "KV cache aware
routing load balances...") so it matches the title and other instances; ensure
the exact text "KV cache-aware routing" is used for consistency across the
document.

---

Outside diff comments:
In `@docs/getting-started/introduction.md`:
- Line 156: Update the link text token "[KV Cache Aware Routing]" to use the
hyphenated form "[KV Cache-Aware Routing]" so it matches the rest of the
document; locate the markdown link line containing "KV Cache Aware Routing" and
replace the visible link text only (not the URL) with "KV Cache-Aware Routing".

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a34bd3c1-3592-48f7-92ca-0397cb01d99c

📥 Commits

Reviewing files that changed from the base of the PR and between 56eacd7 and 8300f8e.

📒 Files selected for processing (1)
  • docs/getting-started/introduction.md

Comment thread docs/getting-started/introduction.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
@github-actions
Copy link
Copy Markdown
Contributor

@nealvaidya nealvaidya merged commit b950034 into main Mar 13, 2026
47 checks passed
@nealvaidya nealvaidya deleted the dagil-nvidia/docs-intro-updates branch March 13, 2026 03:05
galletas1712 pushed a commit that referenced this pull request Mar 13, 2026
Signed-off-by: Dan Gil <dagil@nvidia.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Neal Vaidya <nealv@nvidia.com>
dagil-nvidia added a commit that referenced this pull request Mar 13, 2026
Signed-off-by: Dan Gil <dagil@nvidia.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Neal Vaidya <nealv@nvidia.com>
Signed-off-by: Dan Gil <dagil@nvidia.com>
saturley-hall pushed a commit that referenced this pull request Mar 13, 2026
…7352) (#7354)

Signed-off-by: Dan Gil <dagil@nvidia.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Neal Vaidya <nealv@nvidia.com>
ShounakRay pushed a commit to ShounakRay/fuzzy-dynamo that referenced this pull request Mar 20, 2026
)

Signed-off-by: Dan Gil <dagil@nvidia.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Neal Vaidya <nealv@nvidia.com>
yao531441 pushed a commit to yao531441/dynamo that referenced this pull request May 13, 2026
)

Signed-off-by: Dan Gil <dagil@nvidia.com>
Signed-off-by: dagil-nvidia <dagil@nvidia.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Neal Vaidya <nealv@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants