Skip to content

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

Merged
aybchan merged 55 commits into
mainfrom
aybchan/fern-migration
Jul 7, 2026
Merged

Add Fern docs platform: scaffolding, CI/CD, ecosystem diagram, and new pages#2200
aybchan merged 55 commits into
mainfrom
aybchan/fern-migration

Conversation

@aybchan

@aybchan aybchan commented Jul 2, 2026

Copy link
Copy Markdown
Member

hogepodge and others added 30 commits June 23, 2026 15:35
- 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
@aybchan
aybchan force-pushed the aybchan/fern-migration branch from fa2613b to ec49507 Compare July 2, 2026 17:47
@NVIDIA NVIDIA deleted a comment from github-actions Bot Jul 2, 2026
@NVIDIA NVIDIA deleted a comment from copy-pr-bot Bot Jul 2, 2026
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

@aybchan
aybchan requested a review from olupton July 2, 2026 17:50
olupton
olupton previously approved these changes Jul 3, 2026
Comment thread .github/workflows/fern-docs-ci.yml
Comment thread .github/workflows/fern-docs-preview.yml Outdated
Comment thread .gitignore Outdated
Comment thread README.md
@copy-pr-bot

copy-pr-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

1 similar comment
@copy-pr-bot

copy-pr-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@aybchan

aybchan commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

/ok to test b1f5c2e

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

📖 Docs preview

@aybchan

aybchan commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

/ok to test edde4eb

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

📖 Docs preview

@aybchan

aybchan commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

/ok to test 251c7f8

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

📖 Docs preview

@aybchan
aybchan requested a review from olupton July 7, 2026 13:09

@olupton olupton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one part I didn't follow

Comment thread .github/workflows/fern-docs-preview.yml
@aybchan
aybchan merged commit d29fd15 into main Jul 7, 2026
2 checks passed
@aybchan
aybchan deleted the aybchan/fern-migration branch July 7, 2026 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants