You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/AGENTS.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,10 @@ Use hybrid versioning. A version YAML may reuse older page files for unchanged c
23
23
24
24
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.
25
25
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
+
26
30
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.
Copy file name to clipboardExpand all lines: fern/README.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,6 +77,8 @@ Current Fern versions:
77
77
fern/versions/
78
78
├── latest.yml ← rolling nav file
79
79
├── 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
80
82
├── v0.5.9.yml ← release nav file
81
83
├── v0.5.9/pages/... ← v0.5.9-only page overrides
82
84
├── v0.5.8.yml ← first migrated release nav file
@@ -85,11 +87,13 @@ fern/versions/
85
87
└── older/pages/... ← links to the MkDocs archive
86
88
```
87
89
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.
89
91
90
92
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.
91
93
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.
93
97
94
98
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.
95
99
@@ -130,6 +134,7 @@ fern/
130
134
├── code-reference/ ← gitignored; populated by `make generate-fern-api-reference`
0 commit comments