docs: organize platform-specific prerequisite setup - #7116
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughUpdates platform metadata and generated prerequisite tables, adds canonical DGX Station preparation documentation, revises prerequisite and Quickstart guidance, updates navigation and support matrices, and adds validation for platform documentation ownership and generator behavior. ChangesPlatform prerequisite documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-7116.docs.buildwithfern.com/nemoclaw |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage remains at 96%, unchanged from the TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most impacted files.
Updated |
PR Review Advisor — InformationalAdvisor assessment: Informational / high confidence Model lanes
Nemotron output stays in workflow artifacts and does not change the assessment above. E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: 1 optional E2E recommendation
This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
miyoungc
changed the title
…-station-docs Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/get-started/dgx-station-preparation.mdx`:
- Line 52: Update the Platform Support link in the DGX Station preparation page
to use the correct published route ../../reference/platform-support instead of
../reference/platform-support, preserving the existing link text.
In `@test/station-doc-ownership.test.ts`:
- Around line 21-22: Update the parent describe suite title in “DGX Station
documentation ownership” to end with the required local issue reference suffix
in the form (`#1234`), preserving the existing nested test title.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 1ae16b24-06f4-432c-881c-eabcb7abc280
📒 Files selected for processing (11)
ci/platform-matrix.jsondocs/get-started/dgx-station-preparation.mdxdocs/get-started/prerequisites.mdxdocs/get-started/quickstart.mdxdocs/get-started/windows-preparation.mdxdocs/index.ymldocs/reference/platform-support.mdxscripts/generate-platform-docs.pytest/generate-platform-docs.test.tstest/install-station-platform-identity.test.tstest/station-doc-ownership.test.ts
💤 Files with no reviewable changes (1)
- test/install-station-platform-identity.test.ts
4 participants
Summary
Keep Prerequisites as the universal platform entry point, with clearly labeled preparation pages only for platforms that need them. Keep the generated prerequisite and reference platform tables synchronized while preserving complete Station support and policy details in Platform Support.
Changes
docs/get-started/dgx-station-preparation.mdxas the focused owner of Station qualification, generic Ubuntu preparation, stock DGX OS validation, and reboot handoff.#dgx-station-express-preparationheading as a compatibility pointer to the new Station route.ci/platform-matrix.json, regenerateddocs/reference/platform-support.mdx, and updated the platform docs generator so both tables stay synchronized and the prerequisite table links to the complete matrix, including deferred platforms.Deferred, with compact evaluation guidance fromprerequisites_notes; the DGX Station and Windows row descriptions cross-reference their matching additional-setup pages. Deferred platforms without a documented preparation path, such as RTX, remain in the complete Platform Support matrix only.OSvalues as DGX OS (Spark) and DGX OS (Station), and made both platform tables render in case-insensitive alphabetical order.prerequisites_noteswhile accepting balanced inline code.Type of Change
Quality Gates
Verification
npx vitest run test/install-station-host-preparation.test.ts test/install-station-dgx-os.test.ts test/install-station-platform-identity.test.ts test/station-doc-ownership.test.ts test/windows-preparation-doc-copy.test.ts test/generate-platform-docs.test.ts test/starter-prompt-docs.test.ts test/check-docs-published-routes.test.ts test/check-docs-links.test.ts(184 tests); post-merge platform generator, ownership, route, and link pass (57 tests); malformed-note validation pass (23 tests); final title/sidebar ownership pass (2 tests)Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit