Skip to content

docs: Adding redirects#3965

Merged
nv-anants merged 2 commits into
ai-dynamo:mainfrom
aschilling-nv:afs/redirects
Oct 29, 2025
Merged

docs: Adding redirects#3965
nv-anants merged 2 commits into
ai-dynamo:mainfrom
aschilling-nv:afs/redirects

Conversation

@aschilling-nv
Copy link
Copy Markdown
Contributor

@aschilling-nv aschilling-nv commented Oct 29, 2025

Overview:

Creates redirects for pages that were moved in #3802.

Details:

Adds 13 redirects to the conf.py and updates README.md with instructions on how to add redirects in the future.

Where should the reviewer start?

  • docs/README.md
  • docs/conf.py

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: #xxx

Summary by CodeRabbit

  • Documentation

    • Added redirect creation guidance to the documentation README with external references and configuration instructions.
  • Chores

    • Configured URL redirects for guides, architecture, Kubernetes, fault tolerance, and routing documentation paths to maintain accessibility.

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
@aschilling-nv aschilling-nv requested a review from a team as a code owner October 29, 2025 19:39
@aschilling-nv aschilling-nv requested a review from a team October 29, 2025 19:39
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Oct 29, 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.

@github-actions
Copy link
Copy Markdown
Contributor

👋 Hi aschilling-nv! Thank you for contributing to ai-dynamo/dynamo.

Just a reminder: The NVIDIA Test Github Validation CI runs an essential subset of the testing framework to quickly catch errors.Your PR reviewers may elect to test the changes comprehensively before approving your changes.

🚀

@github-actions github-actions Bot added docs external-contribution Pull request is from an external contributor labels Oct 29, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 29, 2025

Walkthrough

Documentation updates introduce redirect creation guidance in the README and add a redirects configuration dictionary to Sphinx's conf.py, mapping deprecated documentation URL paths to their new destinations for improved navigation.

Changes

Cohort / File(s) Summary
Documentation updates
docs/README.md
Added "Redirect Creation" section with description, external reference link, and instructions to add redirects to conf.py's configuration
Configuration updates
docs/conf.py
Introduced redirects dictionary containing multiple URL mappings for guides, architecture, Kubernetes, fault tolerance, and routing paths

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Both changes are straightforward: one is purely documentation guidance, the other is a static configuration dictionary with no logic
  • No structural complexity or interdependencies to verify
  • Quick scan needed to validate URL mappings in conf.py are correct and that README guidance aligns with the configuration

Poem

🐰 Hops of joy, a path made clear,
Old URLs redirected far and near,
Documentation blooms with gentle care,
Guides and routes now point you there!

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "docs: Adding redirects" directly summarizes the main change in the changeset. The title clearly indicates that the modification concerns documentation and specifically involves adding redirects, which aligns with the changes shown in both docs/README.md (new redirect creation guidance) and docs/conf.py (new redirects dictionary). The title is concise, specific, and uses a standard scope prefix format that effectively communicates the primary purpose of the change.
Description Check ✅ Passed The pull request description includes all required sections from the template: Overview clearly states the purpose (creating redirects for moved pages), Details describes the specific changes (13 redirects added and README updated with instructions), and "Where should the reviewer start?" identifies the two modified files. The Related Issues section is present but uses a placeholder value (#xxx) rather than an actual issue number, though the description adequately references PR #3802 which provides context. Overall, the description is mostly complete and communicates the changes effectively.

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.

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: 2

📜 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 52090e2 and 996e76d.

📒 Files selected for processing (2)
  • docs/README.md (1 hunks)
  • docs/conf.py (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/README.md

75-75: Link text should be descriptive

(MD059, descriptive-link-text)

⏰ 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

Comment thread docs/conf.py
Comment thread docs/README.md
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
@athreesh
Copy link
Copy Markdown
Contributor

/ok to test 2aa2756

Comment thread docs/conf.py
@nv-anants nv-anants merged commit 7b709c4 into ai-dynamo:main Oct 29, 2025
24 of 25 checks passed
dagil-nvidia pushed a commit that referenced this pull request Oct 29, 2025
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Dan Gil <dagil@nvidia.com>
dagil-nvidia pushed a commit that referenced this pull request Oct 29, 2025
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Dan Gil <dagil@nvidia.com>
nv-tusharma pushed a commit that referenced this pull request Oct 29, 2025
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Dan Gil <dagil@nvidia.com>
Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>
karen-sy pushed a commit that referenced this pull request Oct 29, 2025
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
csabakecskemeti pushed a commit to csabakecskemeti/dynamo that referenced this pull request Oct 31, 2025
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
yao531441 pushed a commit to yao531441/dynamo that referenced this pull request May 13, 2026
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs external-contribution Pull request is from an external contributor size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants