Skip to content

Commit 12b89ea

Browse files
committed
docs: fix Fern versioned plugin docs
1 parent ef761b8 commit 12b89ea

21 files changed

Lines changed: 2316 additions & 23 deletions

fern/AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ Use hybrid versioning. A version YAML may reuse older page files for unchanged c
2323

2424
Example: a `v0.5.9` nav entry can point to `./v0.5.8/pages/concepts/columns.mdx`. Users still see the page under the active `v0.5.9` URL because Fern routes by version slug and nav title, not by source file path.
2525

26+
Before editing a file under an older shared tree such as `fern/versions/v0.5.8/pages/...`, check every `fern/versions/*.yml` file that points at it. If the content describes a newer release, copy it into `latest/pages/...` and the target `vX.Y.Z/pages/...` tree, then retarget only those nav entries.
27+
28+
Dev Notes are versioned. Do not add a new release-specific post to an older frozen nav or page tree. If a post says "As of Data Designer vX.Y.Z", it belongs in `latest.yml` and `vX.Y.Z.yml`, not in older version navs.
29+
2630
Do not call a version frozen if its YAML points at shared pages that may change later. If a page's content must remain release-specific, copy it into `fern/versions/vX.Y.Z/pages/...` and point that version's YAML to the copy.
2731

2832
## Release Prep

fern/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ Current Fern versions:
7777
fern/versions/
7878
├── latest.yml ← rolling nav file
7979
├── latest/pages/... ← latest-only page overrides
80+
├── v0.6.0.yml ← release nav file
81+
├── v0.6.0/pages/... ← v0.6.0-only page overrides
8082
├── v0.5.9.yml ← release nav file
8183
├── v0.5.9/pages/... ← v0.5.9-only page overrides
8284
├── v0.5.8.yml ← first migrated release nav file
@@ -85,11 +87,13 @@ fern/versions/
8587
└── older/pages/... ← links to the MkDocs archive
8688
```
8789

88-
`docs.yml` registers `slug: latest`, `slug: v0.5.9`, `slug: v0.5.8`, and `slug: older-versions`. The `latest` and `v0.5.9` nav files intentionally reuse the migrated `v0.5.8/pages/` tree for most content so the first Fern-native versions do not duplicate every page. Add version-specific page copies only when content diverges.
90+
`docs.yml` registers `slug: latest`, `slug: v0.6.0`, `slug: v0.5.9`, `slug: v0.5.8`, and `slug: older-versions`. The `latest`, `v0.6.0`, and `v0.5.9` nav files intentionally reuse the migrated `v0.5.8/pages/` tree for unchanged content so Fern-native versions do not duplicate every page. Add version-specific page copies only when content diverges.
8991

9092
Fern version URLs are based on the active version entry, not the source file path. A `v0.5.9` page can point at `./v0.5.8/pages/...` and still render under `/nemo/datadesigner/v0.5.9/...`; users do not see the reused source path.
9193

92-
Dev Notes are versioned: `latest.yml` can include posts from `main` that are not in old release navs yet. Frozen release navs (`v0.5.9.yml`, `v0.5.8.yml`) should include only posts available at that release point.
94+
Before editing a file under an older shared tree such as `fern/versions/v0.5.8/pages/...`, check every `fern/versions/*.yml` file that points at it. If the content describes a newer release, copy it into `latest/pages/...` and the target `vX.Y.Z/pages/...` tree, then retarget only those nav entries.
95+
96+
Dev Notes are versioned: `latest.yml` can include posts from `main` that are not in old release navs yet. Frozen release navs (`v0.6.0.yml`, `v0.5.9.yml`, `v0.5.8.yml`) should include only posts available at that release point. If a Dev Note says "As of Data Designer vX.Y.Z", do not add it to an older frozen nav or an older shared page tree.
9397

9498
Released versions older than `v0.5.8` stay on the MkDocs archive at `https://nvidia-nemo.github.io/DataDesigner/<version>/`. The Fern version picker includes an "Older versions" page linking to those archives.
9599

@@ -130,6 +134,7 @@ fern/
130134
├── code-reference/ ← gitignored; populated by `make generate-fern-api-reference`
131135
└── versions/
132136
├── latest.yml ← rolling navigation tree
137+
├── v0.6.0.yml ← release navigation tree
133138
├── v0.5.9.yml ← release navigation tree
134139
├── v0.5.8.yml ← navigation tree
135140
├── older.yml ← older versions landing page

fern/docs.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,12 @@ experimental:
4545
- ./components
4646
basepath-aware: true
4747
versions:
48-
- display-name: "Latest · v0.5.9"
48+
- display-name: "Latest · v0.6.0"
4949
path: versions/latest.yml
5050
slug: latest
51+
- display-name: "v0.6.0"
52+
path: versions/v0.6.0.yml
53+
slug: v0.6.0
5154
- display-name: "v0.5.9"
5255
path: versions/v0.5.9.yml
5356
slug: v0.5.9
@@ -76,7 +79,7 @@ redirects:
7679
destination: "/nemo/datadesigner/older-versions"
7780

7881
# ---- Historical MkDocs archives ----
79-
# Fern only has real v0.5.8/v0.5.9 entries today. Older released docs remain on the
82+
# Fern only has real version entries starting at v0.5.8. Older released docs remain on the
8083
# legacy MkDocs gh-pages archive, so version-prefixed Fern URLs for those
8184
# releases should leave the Fern site rather than showing current content.
8285
- source: "/nemo/datadesigner/v0.5.7"

fern/versions/latest.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ navigation:
132132
- section: Plugins
133133
contents:
134134
- page: Overview
135-
path: ./v0.5.8/pages/plugins/overview.mdx
135+
path: ./latest/pages/plugins/overview.mdx
136136
- page: Example Plugin
137-
path: ./v0.5.8/pages/plugins/example.mdx
137+
path: ./latest/pages/plugins/example.mdx
138138
- page: FileSystemSeedReader Plugins
139-
path: ./v0.5.8/pages/plugins/filesystem_seed_reader.mdx
139+
path: ./latest/pages/plugins/filesystem_seed_reader.mdx
140140
- page: Discover
141141
path: ./v0.5.8/pages/plugins/discover.mdx
142142
- section: Code Reference
@@ -169,6 +169,8 @@ navigation:
169169
contents:
170170
- page: Overview
171171
path: ./latest/pages/devnotes/index.mdx
172+
- page: Have It Your Way
173+
path: ./latest/pages/devnotes/posts/have-it-your-way.mdx
172174
- page: VLM Long Document Understanding
173175
path: ./latest/pages/devnotes/posts/vlm-long-document-understanding.mdx
174176
- page: Push Datasets to Hugging Face Hub

fern/versions/latest/pages/devnotes/index.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ import { BlogCard, BlogGrid } from "@/components/BlogCard";
99
Welcome to NeMo Data Designer Dev Notes — in-depth guides, benchmark write-ups, and insights from the team building NeMo Data Designer.
1010

1111
<BlogGrid>
12+
<BlogCard
13+
href="/dev-notes/have-it-your-way"
14+
title="Have It Your Way"
15+
description="A plugin framework for the custom pieces every real project ends up needing."
16+
date="May 5, 2026"
17+
authors={["jgreco", "etramel"]}
18+
image={<img src="/assets/have-it-your-way/data-designer-plugins-hero.png" alt="" loading="lazy" />}
19+
/>
1220
<BlogCard
1321
href="/dev-notes/vlm-long-document-understanding"
1422
title="Training a VLM to Understand Long Documents"

fern/versions/v0.5.8/pages/devnotes/posts/have-it-your-way.mdx renamed to fern/versions/latest/pages/devnotes/posts/have-it-your-way.mdx

File renamed without changes.

0 commit comments

Comments
 (0)