dynamo-docs

name	dynamo-docs
description	Maintain Dynamo Fern docs site -- add, update, move, or remove pages. Use for any documentation changes.

Dynamo Docs Maintenance

Unified skill for adding, updating, moving, and removing pages on the Dynamo Fern documentation site.

Branch Rule

ALL edits happen on main (or a feature branch based on main). The docs-website branch is CI-managed and must never be edited by hand.

Operations

Add a Page

1. Gather: page title, target section, filename (kebab-case .md), subdirectory under docs/.
2. Create docs/<subdirectory>/<filename>.md:

---
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
title: <Page Title>
---

# <Page Title>

3. Add a nav entry in docs/index.yml under the correct section:

- page: <Page Title>
  path: <subdirectory>/<filename>.md

Update a Page

1. Locate by file path, page title, or keyword search (grep -rn in docs/).
2. Content only -- edit the markdown file directly.
3. Title change -- update both the frontmatter title: and the - page: name in docs/index.yml.
4. Section move -- git mv the file, remove old nav entry, add new one, update all incoming links.

Remove a Page

1. Find incoming links: grep -r "<filename>" docs/ --include="*.md".
2. git rm docs/<subdirectory>/<filename>.md.
3. Remove the - page: block from docs/index.yml. If it was the last page in a section, remove the entire - section: block.
4. Fix or remove all incoming links found in step 1.

---

Content Guidelines

Use GitHub-flavored markdown. CI auto-converts callouts to Fern format:

GitHub Syntax	Fern Component
> [!NOTE]	<Note>
> [!TIP]	<Tip>
> [!IMPORTANT]	<Info>
> [!WARNING]	<Warning>
> [!CAUTION]	<Error>

Reference images from docs/assets/.

Section Banners in index.yml

Search for:

• # ==================== Getting Started ====================
• # ==================== Kubernetes Deployment ====================
• # ==================== User Guides ====================
• # ==================== Backends ====================
• # ==================== Components ====================
• # ==================== Integrations ====================
• # ==================== Documentation ====================
• # ==================== Design Docs ====================
• # ==================== Blog ====================
• # ==================== Hidden Pages ====================

Validate

fern check
fern docs broken-links

Optional local preview: fern docs dev (localhost:3000, hot reload, no token).

Commit

git add docs/
git commit -s -m "docs: <add|update|remove> <page-title>"

Debugging

Symptom	Fix
fern check YAML error	Check 2-space indent; - page: must be inside contents:
Missing/orphaned file	path: in index.yml must match actual file location
Broken links in CI	grep -r "<filename>" docs/ and fix stale references
MDX parse error	Replace <https://...> with [text](https://...)
Page missing from site	Ensure nav entry exists in index.yml; allow a few minutes for sync

Key References

File	Purpose
docs/index.yml	Navigation tree
docs/	Content directory
docs/assets/	Images, SVGs, fonts
fern/docs.yml	Fern site configuration
fern/convert_callouts.py	Callout conversion (GitHub -> Fern)
docs/README.md	Full architecture guide