docs: simplify README and make landing docs agent-agnostic#4552
Merged
Conversation
Move duplicated quickstart and Model Router content into the docs site, retire the experimental Hermes label, and sync the platform matrix to prerequisites.mdx with MDX-safe sentinels.
Contributor
|
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 (1)
📝 WalkthroughWalkthroughThis PR rebrands docs from OpenClaw to NemoClaw/OpenShell, adds explicit OpenClaw and Hermes quickstarts, relocates the generated platform matrix into prerequisites.mdx (with script and pre-commit updates), removes the Hermes experimental warning, and expands Model Router inference guidance with examples and credential-flow notes. ChangesDocumentation Rebranding and Structure Updates
🎯 2 (Simple) | ⏱️ ~10 minutes Possibly Related PRs
Suggested Labels
Suggested Reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-4552.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
Contributor
PR Review AdvisorFindings: 0 needs attention, 3 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Since last review detailsCurrent findings:
This is an automated advisory review. A human maintainer must make the final merge decision. |
Bring back the Page | Description table with all doc links so the simplified README still points readers to the full docs site map.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/about/overview.mdx (1)
8-8: ⚡ Quick winNormalize branded term casing in keywords.
Use
OpenClaw,NVIDIA OpenShell, andNVIDIAcapitalization inkeywordsto match the project word list.As per coding guidelines: “NVIDIA must be all caps” and “NemoClaw, OpenClaw, and OpenShell must use correct casing.”
🤖 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/about/overview.mdx` at line 8, Update the keywords array so branded terms use the project's canonical casing: change "nemoclaw overview" to "NemoClaw overview", "openclaw always-on assistants" to "OpenClaw always-on assistants", and apply all-caps to NVIDIA where present (e.g., "nvidia openshell" → "NVIDIA OpenShell", "nvidia nemotron" → "NVIDIA Nemotron"); ensure the keywords array uses these exact corrected strings and leave unrelated entries (like "hermes agent") unchanged.
🤖 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.
Nitpick comments:
In `@docs/about/overview.mdx`:
- Line 8: Update the keywords array so branded terms use the project's canonical
casing: change "nemoclaw overview" to "NemoClaw overview", "openclaw always-on
assistants" to "OpenClaw always-on assistants", and apply all-caps to NVIDIA
where present (e.g., "nvidia openshell" → "NVIDIA OpenShell", "nvidia nemotron"
→ "NVIDIA Nemotron"); ensure the keywords array uses these exact corrected
strings and leave unrelated entries (like "hermes agent") unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 71318e8c-071b-493e-a8a6-0febc55773f8
📒 Files selected for processing (9)
.pre-commit-config.yamlREADME.mddocs/about/how-it-works.mdxdocs/about/overview.mdxdocs/get-started/prerequisites.mdxdocs/get-started/quickstart-hermes.mdxdocs/index.mdxdocs/inference/inference-options.mdxscripts/generate-platform-docs.py
💤 Files with no reviewable changes (1)
- docs/get-started/quickstart-hermes.mdx
ericksoa
approved these changes
May 29, 2026
Contributor
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
LGTM for the docs/README simplification. I reviewed the README/docs generator changes on c5f186f and locally verified the generated platform docs are in sync with python3 scripts/generate-platform-docs.py --check; diff whitespace checks are clean as well. CodeRabbit's metadata keyword-casing note is non-blocking.
Format the alpha notice as a GitHub blockquote alert and list supported agents as bullets instead of inline prose.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Simplifies the GitHub README into a short landing page and updates the docs site intro pages to describe NemoClaw as an agent-agnostic sandbox stack. OpenClaw and Hermes are both listed as supported agents, and Hermes is no longer labeled experimental.
Related Issue
None.
Changes
README.mdto point at docs for prerequisites, quickstarts, and deep topics instead of duplicating them inline.docs/index.mdx,docs/about/overview.mdx, anddocs/about/how-it-works.mdxwith agent-agnostic framing and links to both OpenClaw and Hermes quickstarts.docs/get-started/quickstart-hermes.mdx.docs/inference/inference-options.mdx.README.mdtodocs/get-started/prerequisites.mdxusing MDX{/* */}sentinels so Fern builds cleanly.Type of Change
Verification
npx prek run --all-filespasses (pre-commit hooks on commit)npm testpassesnpm run docsbuilds without warnings (doc changes only)Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
Chores