fern-docs

Maintains the NeMo AutoModel Fern documentation site by managing MDX pages, navigation, redirects, and version trains.

960|316|Updated May 21, 2025
One-click install
npx skills add https://github.com/NVIDIA-NeMo/Automodel --skill fern-docs-nvidia-nemo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fern-docs
Source: https://github.com/NVIDIA-NeMo/Automodel/tree/main/.agents/contributor-skills/fern-docs
Command: npx skills add https://github.com/NVIDIA-NeMo/Automodel --skill fern-docs-nvidia-nemo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a multi-version Fern documentation site consistent is error-prone: pages must be added to the right MDX tree, navigation YAML must stay in sync, redirects must preserve old URLs, and frozen GA snapshots live on a separate archive branch. This Skill encodes the full operational playbook for the NeMo AutoModel docs site so edits, moves, and releases follow the correct procedure every time. ## Core Features & Use Cases - Page lifecycle management: Add, update, move, or remove MDX pages under docs/ with correct frontmatter, sidebar entries in nightly.yml, and slug handling. - Redirect and versioning operations: Configure redirects: rules in docs/fern/docs.yml (including :path* edge cases) and cut new version trains by snapshotting nightly content onto the docs-archive branch. - Validation and preview workflows: Run make docs-check (fern check), local previews, shared preview URLs, and production publishes, with a debugging table for common failures. - Use Case: When asked to add a fine-tuning guide for a new model, the Skill creates the MDX file with proper frontmatter, registers it in the navigation YAML under the right section, and validates the change with fern check before commit. ## Quick Start Ask the assistant to add a new documentation page to the NeMo AutoModel Fern docs site, for example a fine-tuning guide under the Recipes section, and have it create the MDX file, update the navigation, and run validation.

Frequently Asked Questions about fern-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new page to a Fern documentation site?

Create a kebab-case MDX file under docs/ with title and description frontmatter, then add a page entry with path and slug to the version navigation YAML such as nightly.yml. Run fern check via make docs-check to validate before committing.

How do I rename a URL slug in Fern docs without breaking links?

Change the slug field in the version navigation YAML, then add a redirects entry in docs/fern/docs.yml mapping the old path to the new one. Also grep the MDX content for incoming links to the old slug and update them.

Why does fern check fail with folder not found for product-docs?

The generated API reference under docs/fern/product-docs/ is gitignored, so a cold checkout lacks it. Run make docs once, which executes fern docs md generate to populate the library reference before starting the dev server.

Can Fern docs use GitHub-style note callouts in MDX?

No, GitHub alert syntax like > [!NOTE] does not render in Fern MDX. Use Fern-native components instead: Note, Tip, Info, Warning, and Error, plus Cards and Tag for landing pages and badges.

Why do Fern broken-link warnings appear on version-agnostic paths?

Fern's strict validator does not resolve version-agnostic internal links like /get-started/installation, producing false positives for version-prefixed routes. The published site renders them correctly, and the URLMap-based validator is authoritative.

How do I cut a new documentation version train in Fern?

Snapshot the nightly docs tree into docs/fern/versions/<v>/pages, copy and rewrite the navigation YAML, repoint latest.yml, add the version to docs.yml, then move the frozen pages to the docs-archive branch and register it in the stitch-fern-versions workflows.