chore: deprecate MkDocs docs#687
Draft
andreatgretel wants to merge 1 commit into
Draft
Conversation
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
Contributor
|
Fern preview: https://nvidia-preview-pr-687.docs.buildwithfern.com/nemo/datadesigner
|
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
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
Deprecate MkDocs as an active docs system now that Fern is the canonical Data Designer docs surface. This freezes the legacy GitHub Pages archive for
0.5.7and older while removing the source, CI, dependencies, and contributor guidance that kept generating new MkDocs builds.🔗 Related Issue
N/A
🔄 Changes
✨ Added
docs/README.mdto make the remainingdocs/directory explicitly support-only for notebook sources, Colab notebooks, docs scripts, and downloadable recipe scripts.gh-pagesarchive inVERSIONING.md.🔧 Changed
docs-preview.ymlto Fern-only preview/check behavior and removed the Cloudflare MkDocs preview deploy.build-docs.ymlfallback frompublish-fern-devnotes.yml.pyproject.tomland refresheduv.lock.docs.nvidia.com/nemo/datadesigner.🗑️ Removed
mkdocs.yml,.github/workflows/build-docs.yml,.github/workflows/publish-devnotes.yml, and the MkDocs-only devnote nav patch helper.docs/code_reference/,docs/concepts/,docs/devnotes/,docs/images/,docs/plugins/,docs/recipes/,docs/css/,docs/js/,docs/overrides/, anddocs/index.md./siteMkDocs build-output ignore entry.🔍 Attention Areas
docs/— this PR intentionally keeps Fern support inputs there instead of movingfern/underdocs/; moving Fern can happen separately.docs-preview.yml— now only posts Fern previews and no longer publishes a MkDocs/Cloudflare preview.fern/docs.yml— existing redirects remain the active bridge to current Fern docs and the frozen MkDocs archives for0.5.7and older.🧪 Testing
.venv/bin/ruff check --fix ..venv/bin/ruff format .make check-fern-docs-locally(fern check: 0 errors, 2 existing warnings)make generate-colab-notebooksgit diff --check HEADmake testpasses (not run; docs/CI cleanup only)✅ Checklist
Description updated with AI