Skip to content

docs(dev): drop dead links to unwritten local-dev flow pages#241

Open
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-local-dev-flow-links
Open

docs(dev): drop dead links to unwritten local-dev flow pages#241
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-local-dev-flow-links

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

docs/dev/local-development.md linked to 4 per-flow pages that were never written. Removed the dead links and pointed readers to the Topologies and Install paths sections on the same page.

Tested: no remaining dead links, ran ./tools/ci/check-docs (0 errors).

Refs: NO-REF

The four per-flow pages under docs/dev/local-development/ were never
written. Point readers at the Topologies and Install paths sections on
this same page instead of a dead link.

JIRA: NO-REF
NVBug: none
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil
mesutoezdil requested a review from a team as a code owner July 17, 2026 16:39
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The local-development guide now documents four canonical development flows using topology and installation path, and removes a redundant statement about flow-specific prerequisite pages.

Changes

Local development documentation

Layer / File(s) Summary
Canonical flow guidance
docs/dev/local-development.md
The “Pick a flow” section now uses a simplified table for four topology and installation-path combinations, and the redundant prerequisite note is removed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: removing dead links to unwritten local-development flow pages.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant