chore: deprecate MkDocs docs#687
Conversation
|
Fern preview: https://nvidia-preview-pr-687.docs.buildwithfern.com/nemo/datadesigner
|
64bf1d7 to
feafa25
Compare
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
feafa25 to
06dcf0f
Compare
Fern derives page slugs from the nav title and drops the '&' in 'Architecture & Performance', so the canonical path is concepts/architecture-performance, not architecture-and-performance. The latter has no redirect and 404s.
|
Nice work on this cleanup, @andreatgretel — the MkDocs retirement boundary is much clearer now. SummaryThis PR removes the active MkDocs docs system from FindingsWarnings — Worth addressing
Suggestions — Take it or leave it
What Looks Good
VerdictNeeds changes — please address the docs preview trigger gap and the broken Nemotron Colab image URLs before merge. The top-model helper cleanup is optional, but it would keep the new docs ownership model tidy. This review was generated by an AI assistant. |
johnnygreco
left a comment
There was a problem hiding this comment.
Approving per maintainer request. Please see my review comment for the warning-level follow-ups I found before merge.
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
Summary
Deprecates MkDocs as an active docs system on
mainnow that Fern is the canonical Data Designer docs surface.This PR does not modify the published
gh-pagesarchive. The archive freeze and GitHub Pages redirect behavior were handled in merged PR #688, andgh-pagesis now locked.Changes
mkdocs.yml, and MkDocs-only docs workflows frommain.uv.lock.docs/for Fern support inputs only: notebook sources, generated Colab notebooks, docs scripts, and downloadable recipe assets.https://docs.nvidia.com/nemo/datadesigner.fern/docs.yml.Archive Boundary
mainand stops new MkDocs builds from this branch.gh-pagesand freezes the GitHub Pages archive so only0.5.7and older remain available there.latest,0.6.0,0.5.9, and0.5.8GitHub Pages redirects to Fern.Attention Areas
docs/intentionally remains as a support directory for Fern-linked assets and notebooks..github/workflows/docs-preview.ymlnow posts Fern previews only.fern/docs.ymlremains the active Fern-side bridge for legacy MkDocs/devnotes paths.Testing
.venv/bin/ruff check --fix packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.py.venv/bin/ruff format packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.pymake generate-colab-notebooksmake check-fern-docs(fern check: 0 errors, 1 warning)git diff --check origin/main..HEAD