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
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ 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.
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.
27
27
28
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.
Copy file name to clipboardExpand all lines: fern/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ Current Fern versions:
76
76
```
77
77
fern/versions/
78
78
├── latest.yml ← rolling nav file
79
-
├── latest/pages/... ← latest-only page overrides
79
+
├── latest/pages/... ← optional latest-only page overrides after release divergence
80
80
├── v0.6.0.yml ← release nav file
81
81
├── v0.6.0/pages/... ← v0.6.0-only page overrides
82
82
├── v0.5.9.yml ← release nav file
@@ -87,11 +87,11 @@ fern/versions/
87
87
└── older/pages/... ← links to the MkDocs archive
88
88
```
89
89
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.
91
91
92
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.
93
93
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.
95
95
96
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.
97
97
@@ -104,7 +104,7 @@ When cutting future Fern-native versions, use a hybrid model:
104
104
3. Reuse older page paths for unchanged content.
105
105
4. Copy changed/new pages into `versions/vX.Y.Z/pages/...`.
106
106
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.
108
108
7. Run `make check-fern-docs`.
109
109
110
110
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.
0 commit comments