Skip to content

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

Merged
sbaum1994 merged 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-local-dev-flow-links
Jul 20, 2026
Merged

docs(dev): drop dead links to unwritten local-dev flow pages#241
sbaum1994 merged 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.

@sbaum1994 sbaum1994 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This will need a rebase before merge - repo does have all of these files - they just were blocked by our internal mirror accidentally (we retired the mirror and have to manually bring them over)

@sbaum1994
sbaum1994 self-requested a review July 20, 2026 07:07
@mesutoezdil

Copy link
Copy Markdown
Contributor Author

@sbaum1994 does the same internal mirror issue apply to imports.yaml and .gitlab-ci.yml? opened #258 and #260 assuming those are permanently internal and not present in this public snapshot, want to confirm before those merge

@pdmack

pdmack commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

This PR is one of four that together fix the lychee link check failures currently blocking CI on other PRs (e.g. #252). Verified locally: with #240, #241, #242, and #261 all applied, lychee --offline and fern check both pass with zero errors.

Note: broader broken-link issues remain visible via fern check --broken-links (14 additional errors in nav-tree resolution, pre-existing and out of scope here).

@sbaum1994 -- can you review and approve so these can merge?

@sbaum1994
sbaum1994 removed this pull request from the merge queue due to a manual request Jul 20, 2026
@sbaum1994
sbaum1994 merged commit 957a93f into NVIDIA:main Jul 20, 2026
17 of 18 checks passed
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.

3 participants