Skip to content

docs: switch over to fern#123

Draft
willkill07 wants to merge 6 commits into
NVIDIA:mainfrom
willkill07:wkk_fern-documentation
Draft

docs: switch over to fern#123
willkill07 wants to merge 6 commits into
NVIDIA:mainfrom
willkill07:wkk_fern-documentation

Conversation

@willkill07
Copy link
Copy Markdown
Member

@willkill07 willkill07 commented May 18, 2026

Overview

Switch the documentation site from Sphinx to Fern and migrate the docs content, navigation, and API reference generation to the Fern structure.

  • 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

  • Adds Fern site configuration, NVIDIA assets, shared Fern components, and site styling.
  • Migrates docs pages from the previous Markdown/Sphinx layout to MDX/Fern paths, including getting started, concepts, integrations, plugin docs, reference, resources, and troubleshooting content.
  • Replaces Sphinx-oriented API reference generation with Fern-friendly Python, Node.js, and Rust reference generation scripts.
  • Updates docs build scripts, CI docs workflows, path filters, pre-commit hooks, package metadata, lockfiles, attributions, and contribution/release guidance for the Fern workflow.
  • Validated with just docs, just docs-linkcheck, and uv run pre-commit run --all-files; the Fern checks pass with one light-mode accent contrast warning reported by Fern.

Where should the reviewer start?

Start with fern/docs.yml and scripts/build-docs.sh to understand the new docs entry points and navigation, then sample the migration pattern in docs/index.yml and docs/getting-started/quick-start/index.mdx.

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

Signed-off-by: Will Killian <wkillian@nvidia.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 61675740-634e-4d12-b544-58f86b574484

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

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

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

@github-actions github-actions Bot added size:XXL PR is very large Documentation documentation-related lang:js PR changes/introduces Javascript/Typescript code lang:python PR changes/introduces Python code labels May 18, 2026
@willkill07 willkill07 self-assigned this May 18, 2026
@willkill07 willkill07 added this to the 0.3 milestone May 18, 2026
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 added the DO NOT MERGE PR should not be merged; see PR for details label May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE PR should not be merged; see PR for details Documentation documentation-related lang:js PR changes/introduces Javascript/Typescript code lang:python PR changes/introduces Python code size:XXL PR is very large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant