Skip to content

Migrate docs from Docusaurus to Fern - #83

Merged
atokayev merged 7 commits into
mainfrom
migrate-to-fern
Nov 6, 2026
Merged

atokayev merged 7 commits into
mainfrom
migrate-to-fern

Conversation

@atokayev

@atokayev atokayev commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This moves the CCluster docs from Docusaurus to Fern, following the NVIDIA Fern onboarding guide. Once published, the docs will live at docs.nvidia.com/ccluster and use the shared NVIDIA theme, the same look as docs.nvidia.com/dynamo.

The diff is large mostly because it deletes the Docusaurus app and its package-lock.json. The page content itself is carried over and converted.

What changed

Site setup

  • The Docusaurus config, React components, Docker files, npm dependencies, and old deploy workflows are removed.
  • New Fern config is in fern/. Page order and the sidebar are in docs/index.yml.
  • The Fern CLI is pinned to the org's recommended version (5.168.0).

Content

  • All 21 pages are converted to Fern MDX using built-in components (cards, notes, tabs, frames).
  • The introduction page's three feature cards are now a static table. Fern highlights cards on hover, so they looked clickable even though they had nowhere to link.
  • Page and image names now use lowercase hyphens instead of underscores (for example, /resources/custom-image), as the Fern team recommends for SEO. The old underscore URLs redirect to the new ones in fern/redirects.yml.

Content accuracy
I checked commands against the current CLI and engine versions and fixed what was out of date:

  • ccluster CLI usage now matches the real --help output. The page also notes that ccluster ls doesn't list Dynamo deployments.
  • SDK examples use DeploymentType.INFERENCE_V3. With V2 the API returns no deployments.
  • vLLM examples use vllm serve. The old python -m vllm.entrypoints... commands are marked deprecated, and gRPC uses vllm serve ... --grpc.
  • SGLang uses sglang serve, and ccluster pause/resume are documented correctly.

CI (GitHub Actions)

  • Check: validates the Fern config, MDX, internal links, and file paths on every PR.
  • Preview: posts a preview link on each PR.
  • Publish: publishes to production on every merge to main that changes the docs, as the old site did. It runs the checks first and publishes only if they pass. No release tags or approvals are needed.

Before merging

  • Add the FERN_TOKEN repository secret (requested from the Fern team in #cdd-fern)
  • Confirm the preview link on this PR looks right, including the old-URL redirects

After merging

  • Check that the publish run succeeds and the site is live at docs.nvidia.com/ccluster
  • Decide what happens to docs.centml.ai (for example, redirect it to the new site)

How to test locally

fern login
fern docs dev   # http://localhost:3000/ccluster

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

🌿 Preview your docs: https://nvidia-preview-pr-83.docs.buildwithfern.com/ccluster

@anurlybayev

Copy link
Copy Markdown
Contributor

@atokayev so what happens after we merge this? https://docs.centml.ai will exist, but will stop receiving updates? Currently, Fern site is in preview. What is the process of going from Preview to Prod? When we go to prod, will we remove the old site or should we setup a redirect?

@atokayev

atokayev commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor Author

@atokayev so what happens after we merge this? https://docs.centml.ai will exist, but will stop receiving updates? Currently, Fern site is in preview. What is the process of going from Preview to Prod? When we go to prod, will we remove the old site or should we setup a redirect?

Yes, this change replaces old docs update pipeline entirely. After the merge https://docs.centml.ai will no longer get updates and will become stale.
The new CI process will make updates to the new docs URL: docs.nvidia.com/ccluster.
Once we are good with the new docs contents we should enable a redirect from https://docs.centml.ai to docs.nvidia.com/ccluster.

This change also includes some corrects in the documentation fixing outdated items

@Dhruv-Mehndhiratta-Centml

Copy link
Copy Markdown
Contributor

Feedback points

  1. the sidebar line is not matching with the above heading vertical bar in the header section
image 2. this dropdown in header is unncessary, as it does not have any items under it image 3. the codeblock component is not rendering its content properly and it appears at multiple places, specially these side arrows on the left side, usually curl sample does not have these side arrows image 4. getting support tab, for this tab I think UI was update a long back and now this feature is not available we should remove this tab as UI no longer provides this functionality

… page

- Move navigation into fern/docs.yml to drop the single-item product dropdown
- Hide shell prompt symbols in bash code blocks
- Remove the Requesting Support page and navbar link; redirect old URLs
- Allow the ../docs/ page-path prefix in check-docs-paths
@atokayev

atokayev commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Thank you @Dhruv-Mehndhiratta-Centml
For point 1 "sidebar missmatch":
I believe this CSS comes as default for all Nvidia Fern documentation websites.
For example, Dynamo docs also have the same problem. It is not just that obvious.
Screenshot 2026-11-06 at 9 39 26 AM

It is not recommended to do custom CSS. If it is important we can arrange UI elements similar to Dynamo Docs and move navigation bar to the top, rather than having it at the side. I just tried to make least invasive migration.

@atokayev

atokayev commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

@Dhruv-Mehndhiratta-Centml for the remaining points:
2. Empty dropdown: Fern shows a product switcher whenever the config uses products:, even with a single product. I moved the navigation directly into docs.yml and the dropdown is gone.
3. Arrows in code blocks: Fern adds $ / > prompt symbols to shell blocks by default. I turned them off on all shell examples.
4. Requesting Support: removed the page, its sidebar entry, and the "Get Support" navbar link. Old links redirect to the Quickstart, and pages that linked to it now say to contact your NVIDIA representative.

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.

3 participants