Skip to content

Commit 7d2785a

Browse files
committed
docs: dedupe latest Fern release pages
1 parent 162e63b commit 7d2785a

9 files changed

Lines changed: 11 additions & 1536 deletions

File tree

fern/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ 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.
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 the target `vX.Y.Z/pages/...` tree and retarget that release. Point `latest.yml` at the released copy unless latest has already diverged after that release.
2727

2828
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.
2929

fern/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Current Fern versions:
7676
```
7777
fern/versions/
7878
├── latest.yml ← rolling nav file
79-
├── latest/pages/... ← latest-only page overrides
79+
├── latest/pages/... ← optional latest-only page overrides after release divergence
8080
├── v0.6.0.yml ← release nav file
8181
├── v0.6.0/pages/... ← v0.6.0-only page overrides
8282
├── v0.5.9.yml ← release nav file
@@ -87,11 +87,11 @@ fern/versions/
8787
└── older/pages/... ← links to the MkDocs archive
8888
```
8989

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.
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 older version page trees for unchanged content so Fern-native versions do not duplicate every page. Add version-specific page copies only when content diverges.
9191

9292
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.
9393

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.
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 the target `vX.Y.Z/pages/...` tree and retarget that release. Point `latest.yml` at the released copy unless latest has already diverged after that release.
9595

9696
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.
9797

@@ -104,7 +104,7 @@ When cutting future Fern-native versions, use a hybrid model:
104104
3. Reuse older page paths for unchanged content.
105105
4. Copy changed/new pages into `versions/vX.Y.Z/pages/...`.
106106
5. Point only changed nav entries at the copied `vX.Y.Z` pages.
107-
6. Update `latest.yml` if the rolling docs should diverge after release prep.
107+
6. Point `latest.yml` at the new release copy. Use `latest/pages/...` only for post-release divergence.
108108
7. Run `make check-fern-docs`.
109109

110110
Do not add a new version entry without deciding which pages are release-specific. A version YAML that points at shared pages can drift when those shared files change later.

fern/versions/latest.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ navigation:
132132
- section: Plugins
133133
contents:
134134
- page: Overview
135-
path: ./latest/pages/plugins/overview.mdx
135+
path: ./v0.6.0/pages/plugins/overview.mdx
136136
- page: Example Plugin
137-
path: ./latest/pages/plugins/example.mdx
137+
path: ./v0.6.0/pages/plugins/example.mdx
138138
- page: FileSystemSeedReader Plugins
139-
path: ./latest/pages/plugins/filesystem_seed_reader.mdx
139+
path: ./v0.6.0/pages/plugins/filesystem_seed_reader.mdx
140140
- page: Discover
141141
path: ./v0.5.8/pages/plugins/discover.mdx
142142
- section: Code Reference
@@ -168,11 +168,11 @@ navigation:
168168
- section: Dev Notes
169169
contents:
170170
- page: Overview
171-
path: ./latest/pages/devnotes/index.mdx
171+
path: ./v0.6.0/pages/devnotes/index.mdx
172172
- page: Have It Your Way
173-
path: ./latest/pages/devnotes/posts/have-it-your-way.mdx
173+
path: ./v0.6.0/pages/devnotes/posts/have-it-your-way.mdx
174174
- page: VLM Long Document Understanding
175-
path: ./latest/pages/devnotes/posts/vlm-long-document-understanding.mdx
175+
path: ./v0.6.0/pages/devnotes/posts/vlm-long-document-understanding.mdx
176176
- page: Push Datasets to Hugging Face Hub
177177
path: ./v0.5.8/pages/devnotes/posts/push-datasets-to-hugging-face-hub.mdx
178178
- page: Text-to-SQL for Nemotron Super

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

Lines changed: 0 additions & 107 deletions
This file was deleted.

0 commit comments

Comments
 (0)