Repository navigation
Conversation
chenopis
added
docs-only
chenopis
force-pushed
the
docs/fern-mdx-migration
branch
from
June 8, 2026 13:07
b95fd1e to
eed36b0
Compare
chenopis
force-pushed
the
docs/fern-mdx-migration
branch
from
June 8, 2026 13:13
eed36b0 to
328658e
Compare
chenopis
force-pushed
the
docs/fern-mdx-migration
branch
from
June 8, 2026 19:09
48dced7 to
9c030ac
Compare
De-risk commit: capturing the stranded working-tree migration state (114 deletions of Sphinx/MyST .md, 56 modified, 124 .mdx authored, docs/fern/ infra present). Checkpoint only — completeness + template-conformance pass not yet verified; not for merge as-is. Signed-off-by: Andrew Chen <andrewch@nvidia.com>
…ance report - Add docs/fern/versions/v0.4.yml mirroring nightly.yml navigation for the v0.4.x / NeMo Framework 26.04 stable release (latest git tag: v0.4.2). Version source: git tags (v0.4.2 is latest stable) + package_info.py MAJOR=0 MINOR=4 at time of migration. Display name "v0.4 (26.04)" aligns the Megatron-Bridge semver with the NeMo Framework container release label used in software-versions.mdx. - Register the v0.4 version in docs/fern/docs.yml alongside Nightly. - Add docs/fern/CONFORMANCE-REPORT.md: tpl-lint sweep of all 124 MDX pages. Findings: 0 true errors; 37 uniform false-positives (duplicate_h1 from code-block comment lines — known tpl-lint limitation); warnings are orphan_heading style advisories only. Signed-off-by: Andrew Chen <andrewch@nvidia.com>
The page was relocated to docs/training/ but kept images/X relative refs, which resolved to docs/training/images/ (unrelated assets) instead of the shared docs/images/. Repath the 6 refs to ../images/X, matching sibling training pages' convention for shared images. fern check now reports 0 errors. Signed-off-by: Andrew Chen <andrewch@nvidia.com>
fern docs dev failed to parse 3 files (defects fern check missed):
- nemo2-to-megatron-bridge.mdx + training/performance-tuning.mdx: un-converted
HTML comments (<!-- -->) -> MDX comment syntax ({/* */}).
- training/hierarchical-context-parallel.mdx: raw <= read as a JSX tag -> escaped (\<=).
Verified: all 124 MDX compile clean via @mdx-js/mdx batch compile.
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
chenopis
force-pushed
the
docs/fern-mdx-migration
branch
from
June 15, 2026 17:37
d5edbb4 to
86b790d
Compare
MDX parses {...} as a JS expression, so the unconverted Sphinx/MyST role {py:class}`...` broke the Fern docs build (acorn parse error on training/mixed-precision.mdx). Drop the role wrapper, keep the code span. This was the only remaining {role}`...` / :role:`...` instance in the migration (verified by scan); the preview now builds (126 pages).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
📄 Fern docs preview — built from 126 pages, Build-fix in |
cuichenx
added
area:misc
This branch has not been deployed
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
2 participants
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
Migrates the Megatron-Bridge documentation from Sphinx/MyST to Fern MDX, mirroring the reference migration in NVIDIA-NeMo/Evaluator#1032 (which itself followed Automodel#2291).
Layout
models/,training/,get-started/,about/(incl. release-notes),troubleshooting/,resources/,use-cases/.docs/fern/:docs.yml(nav),fern.config.json,global-theme: nvidia(custom-domaindocs.nvidia.com/nemo/megatron-bridge),versions/{nightly,v0.4}.yml, and the release CI workflows..md/.rstsources removed; MyST directives ({note}, etc.) converted to MDX components (<Note>, …); internal links rewritten to Fern path format.docs/releases/pages were redistributed into the IA (about/release-notes/,troubleshooting/,resources/contributing/).Conformance
Template-conformance checked (
docs/fern/CONFORMANCE-REPORT.md): 0 true errors across 124 pages. (37 flagged items are a known tpl-lint false-positive on#inside code fences — tracked separately.)Scope
Excludes
docs/apidocs/(autodoc2) and3rdparty/per the agreed scope; focuses the hand-authored docset.Status — DRAFT
Branch is currently based on
a80ae1c6; needs a rebase onto currentmainbefore un-drafting. Opened for review/visibility.