Add Fern docs platform: scaffolding, CI/CD, ecosystem diagram, and new pages by zhenghax · Pull Request #2182 · NVIDIA/JAX-Toolbox

zhenghax · 2026-06-25T00:11:27Z

Summary

Adds Fern documentation scaffolding (fern/docs.yml, fern/fern.config.json) with custom domain support
Adds interactive ecosystem stack diagram (docs/_components/EcosystemDiagram.tsx, stack.ts) showing the JAX-on-NVIDIA-GPU software stack
Adds new documentation pages: introduction, getting-started guides, environment variables, cloud providers, container versions, FAQ, resources, staging containers, and JAX inference offloading
Adds three CI/CD GitHub Actions workflows: Fern docs CI, preview deploys, and production publish
Refines existing docs (GPU performance, AXLearn, MaxText, resiliency examples) and cleans up broken links
Adds Makefile, .nvmrc, .npmrc, package.json for Node/Fern toolchain

Test plan

Fern docs build locally via make docs (see fern/README.md)
CI workflow (fern-docs-ci.yml) passes on branch
Preview deploy workflow triggers on PR
Ecosystem diagram renders correctly in docs site
All internal links resolve

🤖 Generated with Claude Code

- fern/fern.config.json: org nvidia, pinned to CLI 5.44.3 - fern/docs.yml: site config modeled after ai-dynamo/dynamo — global-theme nvidia, products/versions block, layout, colors, Adobe DTM JS - docs/index.yml: navigation tree (11 pages across 5 sections), paths relative to docs/ following the Dynamo pattern - docs/overview.md: landing page (root README has CI badge tables that don't render in Fern) - docs/GPU_performance.md: escape bare <> placeholder that broke MDX parser - docs/resiliency/example/run_example.md: replace "this directory" file references with GitHub links; add missing H1

- docs/getting-started/{introduction,frameworks,build-status,environment-variables}.md - docs/inference/jax-inference-offloading.md - docs/reference/{container-versions,staging-containers,cloud-providers,faq,resources}.md - fern/README.md Updated docs/index.yml to include all new sections (Getting Started, Inference, Reference). Introduction is now the landing page (slug: /). Modified files restored from origin/main; GPU_performance.md MDX fix reapplied (<> → backtick-escaped placeholder).

- docs/ecosystem/jax-on-nvidia-gpu-stack.mdx: new page with prose framing and <EcosystemDiagram /> component - docs/_components/EcosystemDiagram.tsx: React component driven by DATA injected at build time; all inline styles so NVIDIA global theme CSS cannot override; category color tints (nvidia=green, jax=blue, other=gray) using rgba for light/dark compatibility; centered chip layout with flex-wrap; inset ring for category, outer glow on selection; overview panel with placeholder when nothing selected - docs/ecosystem/stack.yml + projects/*.md: source data for the diagram - scripts/build-ecosystem.mjs: reads stack.yml + project .md files, generates TypeScript DATA block, splices it into EcosystemDiagram.tsx between ECOSYSTEM-DATA markers - fern/docs.yml: add mdx-components path pointing to docs/_components/ - docs/index.yml: add JAX on NVIDIA GPU Stack page to navigation - package.json + scripts: docs:ecosystem, docs:dev, docs:check, docs:preview

Fixes the outdated directory tree (removes fern/components/, adds docs/_components/ and docs/ecosystem/), documents the ecosystem build step and ECOSYSTEM-DATA marker pattern, and explains how to add or update projects in the stack diagram.

The build step existed to generate per-project CSS selectors. Now that the diagram is a React component with all inline styles, no CSS generation is needed — the data is a plain TypeScript module imported directly. - docs/_components/stack.ts: new source of truth; clean object literal with inline descriptions; replaces stack.yml + projects/*.md + build script - docs/_components/EcosystemDiagram.tsx: imports STACK from ./stack; drops ECOSYSTEM-DATA markers and overview wrapper - docs/ecosystem/projects/*.md: deleted (descriptions now inline in stack.ts) - scripts/build-ecosystem.mjs: deleted - package.json: remove docs:ecosystem script and js-yaml dependency - fern/README.md: update build instructions to reflect no build step; document stack.ts project object format

The npm scripts use the local node_modules install, but fern login needs the CLI available globally or via npx.

- JAX/OSS category color changed from blue to purple (#a78bfa) - All category chip background opacity raised to 20% - Cell borders darkened to 60% opacity for more contrast - Description panel name badge now uses the project's category color - Frameworks cell widened to span full training+inference band

- Datacenter, Workstation, GeForce RTX, Jetson now clickable with platform-level descriptions and product family links - Merge Training and Inference into a single 10-unit column

- Uncomment docs.nvidia.com/jax-toolbox/ custom domain in docs.yml - Add fern-docs-ci.yml: PR validation (fern check + broken-links, no token) - Add fern-docs-preview.yml: preview URL on PRs (requires FERN_TOKEN secret) - Add publish-fern-docs.yml: publish to production on main push or dispatch (requires FERN_TOKEN secret)

- Remove axlearn and alphafold3 from project registry - Fix MaxText GPU_performance.md relative path (../../GPU_performance.md) - Fix MaxText example_slurm.sub link (scripts/ subdir did not exist; use GitHub URL) - Remove dead AXLearn EKS workflow YAML links; rewrite Testing section - Fix resiliency example/ directory link to example/run_example.md - All fern docs broken-links checks now pass

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

aschilling-nv

Found an additional fern version.

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

zhenghax · 2026-06-30T20:20:01Z

Found an additional fern version.

Thanks for finding, update the fern version.

olupton · 2026-07-01T20:04:58Z

/ok to test f5cbdcb

Add push trigger for pull-request/* branches (copy-pr-bot pattern) to both workflows so they run with access to repo secrets for external contributors. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

aybchan · 2026-07-06T15:16:56Z

/ok to test bb8365d

github-actions · 2026-07-06T15:17:26Z

📖 Docs preview: https://nvidia-preview-019f3801-669f-70a5-b5b0-8d029fdb4862.docs.buildwithfern.com/jax-toolbox)

aybchan · 2026-07-07T13:36:06Z

Superseded by #2200

…w pages (#2200) #2182 --------- Co-authored-by: Chris Hoge <choge@nvidia.com> Co-authored-by: Zhenghang (Max) Xu <zhenghax@gmail.com> Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

hogepodge and others added 30 commits June 23, 2026 15:35

fern/README.md: clarify fern login requires CLI on PATH

1991ef6

The npm scripts use the local node_modules install, but fern login needs the CLI available globally or via npx.

Updated ecosystem diagram

bd75e35

Update stack.ts

e310a5e

Update EcosystemDiagram.tsx

051fb5b

Update stack.ts

3c65dd6

Update stack.ts

17c8dbe

Update stack.ts

4a1ac6d

Update EcosystemDiagram.tsx

2765b77

Update stack.ts

8126542

Update EcosystemDiagram.tsx

e43e302

Update stack.ts

ac9fa75

Update stack.ts

afe8c52

Update stack.ts

cabad5f

Update stack.ts

a275028

Update stack.ts

66c7cbf

Update stack.ts

522ef94

Update stack.ts

6630bdf

Update stack.ts

f31ef89

Update EcosystemDiagram.tsx

ba14825

Add hardware project descriptions; collapse to two columns

d070fd7

- Datacenter, Workstation, GeForce RTX, Jetson now clickable with platform-level descriptions and product family links - Merge Training and Inference into a single 10-unit column

Matched text to docs description

d230e25

Add outline and guides/ to .gitignore

ff29484

zhenghax and others added 7 commits June 25, 2026 11:03

Update fern/docs.yml

fd09e2c

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

Update fern/docs.yml

cf9fe83

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

Update fern/docs.yml

9d07fb5

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

Merge branch 'main' into fern-migration

cd5cc01

Update README structure

913d020

Add detail to clarify nightly build and NGC release

fc8015f

Remove scale container sections

ccdc125

aybchan previously approved these changes Jun 26, 2026

View reviewed changes

zhenghax requested a review from aschilling-nv June 30, 2026 18:05

aschilling-nv suggested changes Jun 30, 2026

View reviewed changes

Comment thread fern/fern.config.json Outdated

Update fern.config.json

143d2e1

zhenghax dismissed aybchan’s stale review via 143d2e1 June 30, 2026 19:40

aschilling-nv suggested changes Jun 30, 2026

View reviewed changes

Comment thread package.json Outdated

Update package.json

efcabe3

Co-authored-by: Andrew Schilling <85314306+aschilling-nv@users.noreply.github.com>

aschilling-nv approved these changes Jun 30, 2026

View reviewed changes

zhenghax requested a review from aybchan June 30, 2026 20:24

aybchan previously approved these changes Jul 1, 2026

View reviewed changes

Merge branch 'main' into fern-migration

f5cbdcb

Add push trigger for pull request branches

7585b81

aybchan dismissed their stale review via 7585b81 July 2, 2026 17:07

aybchan and others added 2 commits July 2, 2026 18:11

Add push trigger for pull request branches

1c95c32

sync CI/preview workflows with hogepodge/fern-migration

bb8365d

Add push trigger for pull-request/* branches (copy-pr-bot pattern) to both workflows so they run with access to repo secrets for external contributors. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

aybchan mentioned this pull request Jul 7, 2026

Add Fern docs platform: scaffolding, CI/CD, ecosystem diagram, and new pages #2200

Merged

aybchan closed this Jul 7, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Fern docs platform: scaffolding, CI/CD, ecosystem diagram, and new pages#2182

Add Fern docs platform: scaffolding, CI/CD, ecosystem diagram, and new pages#2182
zhenghax wants to merge 46 commits into
NVIDIA:mainfrom
zhenghax:fern-migration

zhenghax commented Jun 25, 2026

Uh oh!

Uh oh!

aschilling-nv left a comment

Uh oh!

Uh oh!

zhenghax commented Jun 30, 2026

Uh oh!

olupton commented Jul 1, 2026

Uh oh!

aybchan commented Jul 6, 2026

Uh oh!

github-actions Bot commented Jul 6, 2026

Uh oh!

aybchan commented Jul 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

zhenghax commented Jun 25, 2026

Summary

Test plan

Uh oh!

Uh oh!

aschilling-nv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zhenghax commented Jun 30, 2026

Uh oh!

olupton commented Jul 1, 2026

Uh oh!

aybchan commented Jul 6, 2026

Uh oh!

github-actions Bot commented Jul 6, 2026

Uh oh!

aybchan commented Jul 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants