Skip to content

docs: revert migration guide#143

Closed
mnajafian-nv wants to merge 1 commit into
NVIDIA:mainfrom
mnajafian-nv:docs/revert-migration-guide
Closed

docs: revert migration guide#143
mnajafian-nv wants to merge 1 commit into
NVIDIA:mainfrom
mnajafian-nv:docs/revert-migration-guide

Conversation

@mnajafian-nv
Copy link
Copy Markdown
Contributor

@mnajafian-nv mnajafian-nv commented May 21, 2026

Overview

Reverts #140 at maintainer request because the migration guide conflicts with an in-progress rename.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

  • Reverts commit 7b8d9c3.
  • Removes docs/getting-started/migration.md.
  • Removes the Migration Paths navigation entry from docs/index.md.

Validation:

  • git diff --check HEAD^ HEAD
  • uv run pre-commit run --files docs/index.md (lychee found no broken links, but the hook rewrote package-lock.json locally; restored before push)
  • just docs
  • just docs-linkcheck

Where should the reviewer start?

Start with the revert commit. The PR only removes the migration guide and its navigation entry.

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

Summary by CodeRabbit

  • Documentation
    • Removed migration paths documentation and updated the main documentation index by removing migration path references from both the "What Should I Read First?" introductory section and the getting started navigation menu, streamlining the documentation structure.

Review Change Stack

This reverts commit 7b8d9c3.

Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
@mnajafian-nv mnajafian-nv requested a review from a team as a code owner May 21, 2026 22:14
@github-actions github-actions Bot added size:S PR is small Documentation documentation-related labels May 21, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 436b9315-7657-4f70-a103-dada5a8d6e25

📥 Commits

Reviewing files that changed from the base of the PR and between 7b8d9c3 and dbaf87d.

📒 Files selected for processing (2)
  • docs/getting-started/migration.md
  • docs/index.md
💤 Files with no reviewable changes (2)
  • docs/getting-started/migration.md
  • docs/index.md
📜 Recent review details
⏰ 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: Check / Run

Walkthrough

The PR removes migration path documentation by deleting the docs/getting-started/migration.md file and removing references to it from the documentation index—specifically the task-to-document table entry and the toctree navigation link.

Changes

Remove Migration Paths Documentation

Layer / File(s) Summary
Remove migration paths references from index
docs/index.md
The "What Should I Read First?" table no longer includes the migration path entry, and the "Getting Started" toctree no longer lists the "Migration Paths" navigation link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • NVIDIA/NeMo-Flow#140: Adds the migration paths documentation and navigation link that this PR removes, creating a direct conflict.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Title follows Conventional Commits format with 'docs' type and concise imperative summary; under 72 characters.
Description check ✅ Passed Description includes all required sections: Overview with confirmation checkboxes, Details with specific changes, reviewer guidance, and Related Issues with revert reference.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@willkill07
Copy link
Copy Markdown
Member

This revert is not needed. I already took care of it in #141

@willkill07 willkill07 closed this May 21, 2026
@mnajafian-nv mnajafian-nv deleted the docs/revert-migration-guide branch May 21, 2026 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:S PR is small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants