docs: migrate documentation from Sphinx to Fern#1062
Conversation
Convert the Sphinx/MyST docs under docs/ to Fern MDX using the convert-to-fern toolkit and cut the docs toolchain over to Fern. - Add docs/fern/ scaffolding: fern.config.json (pinned to fern-api 5.29.0), docs.yml with the NVIDIA global theme, MDX components, and an explicit-slug nightly navigation. - Convert all 29 pages to MDX at docs/<section>/*.mdx with frontmatter and version-agnostic internal links (fern check + broken-links clean). - Add Fern CI workflows (check, preview build/comment, publish) rooted at docs/fern. - Remove Sphinx infrastructure: conf.py, requirements.txt, versions1.json, broken_links_false_positives.json, the release-docs and release-nightly-docs workflows, and the Sphinx docs-version bump in release-freeze. - Point Makefile docs targets at Fern and drop the Sphinx [docs] extra. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (56)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
The release workflow built Sphinx docs via .github/config/requirements.txt, which fails now that docs/conf.py is removed. Fern docs are published by publish-fern-docs.yml, so disable publish-docs in the release library call and drop the unused Sphinx requirements file. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Summary
Migrates the
docs/Sphinx/MyST documentation to Fern MDX, targeting the currentmain(0.3.0) history. This is a fresh re-point of #1032 — that PR was built onmain-legacy, whose docs document the oldnemo-evaluator-launcherCLI; importing it would pollutemainwith stale content. Instead, this PR re-runs the migration againstmain's current docs (the newnelCLI) so the content matches the shipping product.Generated with the
convert-to-ferntoolkit.What changed
docs/fern/:fern.config.json(pinned tofern-api5.29.0, matching NeMo-Curator),docs.ymlwith the NVIDIAglobal-theme, MDX components, and an explicit-slugnightlynavigation.docs/<section>/*.mdx, with frontmatter and version-agnostic internal links.fern-docs-ci,fern-docs-preview-build,fern-docs-preview-comment,publish-fern-docs), rooted atdocs/fern.conf.py,requirements.txt,versions1.json,broken_links_false_positives.json, therelease-docs/release-nightly-docsworkflows, the Sphinx docs-version bump inrelease-freeze, the Sphinx[docs]extra, and the Makefile sphinx targets (nowfern check/fern docs dev).Validation
Both pass locally with the CI-pinned
fern-api@5.29.0:fern check→ All checks passedfern docs broken-links→ ✓ All checks passed (every internal link resolves)Supersedes #1032.
🤖 Generated with Claude Code