docs: retire docs/ Sphinx tree, replace with pointer to fern/#1376
Open
lbliii wants to merge 3 commits into
Open
docs: retire docs/ Sphinx tree, replace with pointer to fern/#1376lbliii wants to merge 3 commits into
lbliii wants to merge 3 commits into
Conversation
Remove the deprecated Sphinx tree under docs/ (78 files: MyST sources, conf.py, _images, autodoc2 parser, Makefile, etc.). This tree was superseded by Fern; subsequent doc edits have been landing in fern/ only. Replace it with a single docs/README.md that points contributors to fern/ for reading, editing, and previewing the published site. Also strip the now-broken sphinx-* wrapper targets from the root Makefile (they delegated to the deleted docs/Makefile). Co-Authored-By: Claude Opus 4.7 <[email protected]> Signed-off-by: Lawrence Lane <[email protected]>
The previous commit deleted docs/Makefile but left the root Makefile's sphinx-* targets (which delegated to it) in place. Remove them. Also reword the docs/README.md back-port pointer so v0.2.1 reads as the example GA at time of writing, not a permanent target; future GAs will land under fern/versions/<ga>/. Co-Authored-By: Claude Opus 4.7 <[email protected]> Signed-off-by: Lawrence Lane <[email protected]>
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 (78 files: MyST sources,conf.py,autodoc2_docstrings_parser.py,_images/,docs/Makefile, etc.). This tree was superseded by Fern; subsequent doc edits have been landing infern/only.docs/README.md— a short pointer tofern/covering where to read the published docs, where to add a page (fern/versions/latest/pages/for bleeding-edge, back-port to the current GA snapshot underfern/versions/<ga>/), how PR previews work, and how legacy/nemo/gym/...URLs are redirected.sphinx-*wrappers from the rootMakefile(they delegated to the deleteddocs/Makefile); Fern targets are untouched.Modeled on NVIDIA-NeMo/Curator#1961.
Test plan
fern/content ordocs.ymlredirects)docs/README.mdrenders correctly on GitHub with working links to../fern/and../fern/README.mdmake docs,make docs-check,make docs-publishstill work end-to-end🤖 Generated with Claude Code