docs: retire docs/ Sphinx tree, replace with pointer to fern/#1961
Open
lbliii wants to merge 3 commits intoNVIDIA-NeMo:mainfrom
Open
docs: retire docs/ Sphinx tree, replace with pointer to fern/#1961lbliii wants to merge 3 commits intoNVIDIA-NeMo:mainfrom
lbliii wants to merge 3 commits intoNVIDIA-NeMo:mainfrom
Conversation
The Sphinx source under docs/ was deprecated when the site moved to Fern; this removes the stale tree and replaces it with a one-page pointer so contributors land in fern/ directly. The new fern/README.md documents the layout, local dev flow, version snapshot/symlink scheme, authoring conventions, CI workflows, and publishing — modeled on NVIDIA-NeMo/Gym#1241. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
Rewrites the top-level Makefile around Fern (`docs`, `docs-check`, `docs-login`, `docs-generate-library`, `docs-substitute`, `docs-preview`, `docs-publish`, `docs-clean`), modeled on the Gym fern README's target ideas. The bare `make docs` target now boots the Fern dev server. Also removes the now-orphaned Sphinx pieces: - .github/workflows/build-docs.yml — invoked the FW-CI Sphinx builder on `docs/`, which no longer exists; would fail on every PR. - requirements-docs.txt — Sphinx/MyST/nvidia-sphinx-theme deps, only referenced by the workflow above and the old Makefile. - .github/copilot-instructions.md `make docs-html` reference. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
Adds the Gym-style separation between bleeding-edge and frozen GA: fern/versions/main.yml # nav stub fern/versions/main/pages/ # one placeholder page `docs.yml` `versions:` gains a "Main (beta)" entry between Latest and v26.04. `main.yml` carries seeding instructions in a header comment so the eventual seed is mechanical: cp -r fern/versions/v26.04/pages/* fern/versions/main/pages/ cp fern/versions/v26.04.yml fern/versions/main.yml sed -i '' 's|\./v26\.04/|./main/|g' fern/versions/main.yml Page seeding is intentionally deferred to a follow-up commit so it doesn't conflict with pending v26.04 content changes. Until then, edits continue to land in v26.04/pages/. README updates reflect the transitional state. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
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
1 participant
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
docs/Sphinx tree (193 files: MyST sources, Sphinx extensions, conf.py, _images, _templates, broken-link allowlists, etc.). This tree has been the historical source for the published site but was superseded by Fern; subsequent doc edits have been landing infern/only. Replace it with a singledocs/README.mdthat points contributors tofern/.fern/README.mdmodeled on NVIDIA-NeMo/Gym#1241. Tailored to Curator's actual layout:v25.09/v26.02/v26.04) withdisplay-namepaired against the git release tag (v1.0.0/v1.1.0/v1.1.2)latest.ymlis a real symlink tov26.04.yml(verifiedlrwxr-xr-x ... -> v26.04.yml)substitute_variables.py(CI/local{{ variable }}replacement) and thelibraries:block (Python autodoc →product-docs/, seeAUTODOCS_GUIDE.md)fern-docs-ci.yml,fern-docs-preview-build.yml,fern-docs-preview-comment.yml,publish-fern-docs.ymlFollow-ups (not in this PR)
Makefilestill has Sphinx targets (docs-html,docs-live,docs-publish,docs-env, etc.) thatcd docs && sphinx-buildand will fail now thatdocs/is empty. Worth a follow-up to either remove them or repoint them atfern/..github/workflows/config/.secrets.baselinehas staledocs/...entries that can be regenerated when convenient — they're harmless allowlist remnants and won't trigger anything.Test plan
fern/content ordocs.ymlredirects)docs/README.mdrenders correctly on GitHub with working links to../fern/and../fern/README.mdfern/README.mdrenders correctly on GitHub/nemo/curator/index.html,/nemo/curator/26.02/...) still redirect via the rules already infern/docs.yml🤖 Generated with Claude Code