Skip to content

docs(chore): add docs site version switcher#1643

Merged
miyoungc merged 1 commit intomainfrom
docs/add-switcher
Apr 9, 2026
Merged

docs(chore): add docs site version switcher#1643
miyoungc merged 1 commit intomainfrom
docs/add-switcher

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 8, 2026 •
edited
Loading

Summary

Add version switcher at the top of the docs site.

Related Issue

Changes

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Code Changes

  • Formatters applied — npx prek run --all-files auto-fixes formatting (or make format for targeted runs).
  • Tests added or updated for new or changed behavior.
  • No secrets, API keys, or credentials committed.
  • Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

  • Follows the style guide. Try running the nemoclaw-contributor-update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/nemoclaw-contributor-update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Signed-off-by: Your Name your-email@example.com

Summary by CodeRabbit

  • Documentation
    • A new documentation version switcher has been added, enabling users to seamlessly navigate between different documentation versions. Users can now easily select the documentation version that corresponds to their installation or needs, improving discoverability and access to version-specific information throughout the documentation site.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 8, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Updated the Sphinx documentation configuration to include an additional JSON file in the HTML extra path and added a version switcher configuration that references this new JSON file for documentation version matching.

Changes

Cohort / File(s) Summary
Sphinx Configuration
docs/conf.py		 Extended html_extra_path to include versions1.json and added switcher configuration under html_theme_options with JSON URL and version matching settings for documentation version switching functionality.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit hops through conf.py with glee,
Adding switcher paths for all to see!
Versions dance in versions1.json so fine,
The docs now switch with a version design! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately describes the main change: adding a docs version switcher to the Sphinx configuration.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-switcher

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

@miyoungc miyoungc requested review from brandonpelfrey and cv April 8, 2026 22:45
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 8, 2026
@miyoungc miyoungc changed the title docs(chore): add version switcher docs(chore): add docs site version switcher Apr 8, 2026
@miyoungc miyoungc merged commit cd19509 into main Apr 9, 2026
15 of 21 checks passed
gemini2026 pushed a commit to gemini2026/NemoClaw that referenced this pull request Apr 14, 2026
@miyoungc @gemini2026
docs(chore): add docs site version switcher (NVIDIA#1643)
473180e 
<!-- markdownlint-disable MD041 -->
## Summary
Add version switcher at the top of the docs site.

## Related Issue
<!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section
if none. -->

## Changes
<!-- Bullet list of key changes. -->

## Type of Change
<!-- Check the one that applies. -->
- [ ] Code change for a new feature, bug fix, or refactor.
- [ ] Code change with doc updates.
- [x] Doc only. Prose changes without code sample modifications.
- [ ] Doc only. Includes code sample changes.

## Testing
<!-- What testing was done? -->
- [x] `npx prek run --all-files` passes (or equivalently `make check`).
- [ ] `npm test` passes.
- [x] `make docs` builds without warnings. (for doc-only changes)

## Checklist

### General

- [x] I have read and followed the [contributing
guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md).
- [x] I have read and followed the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
(for doc-only changes)

### Code Changes
<!-- Skip if this is a doc-only PR. -->
- [ ] Formatters applied — `npx prek run --all-files` auto-fixes
formatting (or `make format` for targeted runs).
- [ ] Tests added or updated for new or changed behavior.
- [ ] No secrets, API keys, or credentials committed.
- [ ] Doc pages updated for any user-facing behavior changes (new
commands, changed defaults, new features, bug fixes that contradict
existing docs).

### Doc Changes
<!-- Skip if this PR has no doc changes. -->
- [ ] Follows the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
Try running the `nemoclaw-contributor-update-docs` agent skill to draft
changes while complying with the style guide. For example, prompt your
agent with "`/nemoclaw-contributor-update-docs` catch up the docs for
the new changes I made in this PR."
- [ ] New pages include SPDX license header and frontmatter, if creating
a new page.
- [ ] Cross-references and links verified.

---
<!-- DCO sign-off (required by CI). Replace with your real name and
email. -->
Signed-off-by: Your Name <your-email@example.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* A new documentation version switcher has been added, enabling users to
seamlessly navigate between different documentation versions. Users can
now easily select the documentation version that corresponds to their
installation or needs, improving discoverability and access to
version-specific information throughout the documentation site.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cv cv cv approved these changes

@brandonpelfrey brandonpelfrey Awaiting requested review from brandonpelfrey

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@miyoungc @cv