Skip to content

docs(fern): scaffold NeMo Retriever Fern docs from MkDocs - #2418

Draft
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:feat/nrl-fern-migration
Draft

docs(fern): scaffold NeMo Retriever Fern docs from MkDocs#2418
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:feat/nrl-fern-migration

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Scaffold Fern docs under docs/fern/ (NVIDIA global theme, nightly nav from MkDocs, redirects, MDX components).
  • Convert published MkDocs pages to Fern MDX under docs/docs/**/*.mdx (MkDocs .md sources remain for dual-publish).
  • Add Fern check / preview / publish GitHub Actions wired to docs/fern and docs/docs.

Notes

  • fern check passes locally (cd docs/fern && fern check).
  • External MkDocs nav links (GitHub quickstart / Helm / CLI / starter kits) are Fern link: entries.
  • Follow-up: canonicalize internal link slugs; add latest.yml when freezing a GA train; confirm DOCS_FERN_TOKEN org secret before publish.

Test plan

  • cd docs/fern && fern check
  • Spot-check sidebar order against docs/mkdocs.yml nav:
  • Preview a few pages (overview, deployment-options, multimodal-extraction) via Fern preview workflow or fern docs dev
  • Confirm Fern CI path filters fire on docs/fern/** and docs/docs/**

Add docs/fern infrastructure (NVIDIA global theme, nightly nav, redirects),
convert published MkDocs pages to MDX under docs/docs, and install Fern
check/preview/publish workflows for the nested docs/fern layout.
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jul 31, 2026
@kheiss-uwzoo kheiss-uwzoo added doc Improvements or additions to documentation 26.01 26.01 Release 26.10 fern and removed 26.01 26.01 Release labels Jul 31, 2026
Rewrite /nightly-pages-extraction/* and legacy stubs to version-agnostic
Fern URLs from nightly.yml, and point images at /assets/images/.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.10 doc Improvements or additions to documentation fern

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant