docs: remaining fern doc fixes - #3780
Conversation
📝 WalkthroughWalkthroughThis PR introduces a reusable BadgeLinks component to display status and policy badges on the homepage, standardizes documentation page titles across 24+ files by removing product-name prefixes, and restructures the navigation configuration with updated labels and a new Runtime Controls section. ChangesBadge Component Feature
Documentation Standardization
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-3780.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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/_components/BadgeLinks.tsx`:
- Around line 1-6: Add the required SPDX license header at the very top of
docs/_components/BadgeLinks.tsx (above the existing file comment) by inserting
an SPDX copyright line with the appropriate copyright holder/year and the
SPDX-License-Identifier for Apache-2.0; ensure the header appears before the
current module comment so the file complies with the repository rule that every
.tsx source must include an SPDX copyright and Apache-2.0 license identifier.
In `@docs/_components/jsx.d.ts`:
- Line 1: Add the required SPDX license header to the top of this new TypeScript
declaration file so it includes both the copyright notice and the Apache-2.0
license identifier; specifically insert the SPDX copyright line and
"SPDX-License-Identifier: Apache-2.0" as the first lines of the file that
contains the declaration "declare const React: unknown;" so the file meets the
repository rule that every source file includes an SPDX header.
In `@docs/index.mdx`:
- Around line 26-27: The badge link targets the wrong filename: update the href
value that currently points to "release-notes.md" so it points to the actual
docs file "release-notes.mdx" (leave the src badge image unchanged);
specifically locate the href assignment in the docs/index.mdx frontmatter and
replace "release-notes.md" with "release-notes.mdx" to fix the broken
cross-reference.
🪄 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: 88df8664-b13e-4fd7-83c9-c3e0dd850600
📒 Files selected for processing (30)
docs/_components/BadgeLinks.tsxdocs/_components/jsx.d.tsdocs/about/ecosystem.mdxdocs/about/how-it-works.mdxdocs/about/overview.mdxdocs/about/release-notes.mdxdocs/deployment/deploy-to-remote-gpu.mdxdocs/deployment/install-openclaw-plugins.mdxdocs/get-started/prerequisites.mdxdocs/get-started/quickstart-hermes.mdxdocs/get-started/windows-preparation.mdxdocs/index.mdxdocs/index.ymldocs/inference/inference-options.mdxdocs/inference/set-up-sub-agent.mdxdocs/inference/switch-inference-providers.mdxdocs/inference/use-local-inference.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/monitoring/monitor-sandbox-activity.mdxdocs/network-policy/approve-network-requests.mdxdocs/network-policy/customize-network-policy.mdxdocs/reference/architecture.mdxdocs/reference/commands.mdxdocs/reference/network-policies.mdxdocs/reference/troubleshooting.mdxdocs/resources/license.mdxdocs/security/best-practices.mdxdocs/security/credential-storage.mdxfern/docs.ymlfern/main.css
| /** | ||
| * Badge links for GitHub, License, project status, Discord, etc. | ||
| * Uses a flex wrapper to display badges horizontally and hides Fern's | ||
| * external-link icon that otherwise stacks under each badge image. | ||
| * Requires the `.badge-links` CSS rule from main.css. | ||
| */ |
There was a problem hiding this comment.
Add SPDX license header to this new TSX source file.
This file is missing the required SPDX copyright and license header.
As per coding guidelines, **/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license.
🤖 Prompt for 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.
In `@docs/_components/BadgeLinks.tsx` around lines 1 - 6, Add the required SPDX
license header at the very top of docs/_components/BadgeLinks.tsx (above the
existing file comment) by inserting an SPDX copyright line with the appropriate
copyright holder/year and the SPDX-License-Identifier for Apache-2.0; ensure the
header appears before the current module comment so the file complies with the
repository rule that every .tsx source must include an SPDX copyright and
Apache-2.0 license identifier.
| @@ -0,0 +1 @@ | |||
| declare const React: unknown; | |||
There was a problem hiding this comment.
Add SPDX license header to this new TypeScript declaration file.
The file currently has no required SPDX copyright/license header.
As per coding guidelines, **/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license.
🤖 Prompt for 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.
In `@docs/_components/jsx.d.ts` at line 1, Add the required SPDX license header to
the top of this new TypeScript declaration file so it includes both the
copyright notice and the Apache-2.0 license identifier; specifically insert the
SPDX copyright line and "SPDX-License-Identifier: Apache-2.0" as the first lines
of the file that contains the declaration "declare const React: unknown;" so the
file meets the repository rule that every source file includes an SPDX header.
| href: "https://github.com/NVIDIA/NemoClaw/blob/main/docs/about/release-notes.md", | ||
| src: "https://img.shields.io/badge/status-alpha-orange", |
There was a problem hiding this comment.
Fix the Release Notes badge target URL.
Line 26 links to release-notes.md, but this docs page is release-notes.mdx in the current structure, so the badge target is likely broken.
As per coding guidelines, Missing SPDX header, broken cross-references, or incorrect code block language: flag as issues.
🤖 Prompt for 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.
In `@docs/index.mdx` around lines 26 - 27, The badge link targets the wrong
filename: update the href value that currently points to "release-notes.md" so
it points to the actual docs file "release-notes.mdx" (leave the src badge image
unchanged); specifically locate the href assignment in the docs/index.mdx
frontmatter and replace "release-notes.md" with "release-notes.mdx" to fix the
broken cross-reference.
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Reviewed the docs-only changes at 028aa50. Fern validation and docs-to-skills dry run pass locally, the generated Release Notes Markdown target exists, and the GitHub docs/link/security/self-hosted checks are green. I do not see a merge-blocking correctness issue here.
wscurran
added
area: docs
3 participants
Summary
Polishes the remaining Fern migration details so the NemoClaw docs preview matches the legacy docs structure more closely. This aligns sidebar labels, MDX page titles, landing-page badges, and Fern component wiring.
Related Issue
None.
Changes
docs/index.ymlnavigation labels and ordering with the intended table of contents, including the nested Windows prerequisites page and Runtime Controls entry.titlevalues with the first H1 from the corresponding legacy.mdpages.fern/docs.ymlfor Fern preview/build resolution.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Additional local verification:
ReadLintsreported no docs diagnostics after the edits.docs/**/*.mdxfrontmattertitlematches the first H1 in the corresponding legacy.mdfile.git diff --checkpassed.npm run docs:strictwas attempted earlier, but the sandboxed environment returned403 Forbiddenwhile fetchingfern-apifrom npm, so Fern CLI validation was not completed locally.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
New Features
Documentation
Style