Skip to content

docs: add fern versioning - #2287

Open
miyoungc wants to merge 38 commits into
developfrom
codex/fresh-worktree-20260812
Open

docs: add fern versioning#2287
miyoungc wants to merge 38 commits into
developfrom
codex/fresh-worktree-20260812

Conversation

@miyoungc

@miyoungc miyoungc commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Description

Use Fern's Git-ref version publishing to add immutable historical documentation versions without copying release content into the current working tree.

  • Keep Latest backed by the current docs/index.yml.
  • Publish v0.23.0 from the stable v0.23.0 Git tag.
  • Publish deprecated v0.22.0 from commit fb73f41b0fa2ef6c50c90d76f8b20533e4c9a51e. The v0.22.0 release tag predates the Fern migration, while this curated post-migration commit contains the required Fern configuration, navigation, and OpenAPI files.
  • Pin Fern CLI 5.91.0, which supports ref-backed documentation versions.
  • Document how to choose an immutable tag or commit SHA and clarify that fern docs dev renders working-tree versions only.

Using immutable refs keeps historical versions stable across republishes and avoids a mutable backfill branch. Areas for careful review are whether the selected v0.22.0 commit represents the intended snapshot and the stable/deprecated availability labels.

Related Issue(s)

Follow-up to #2262. No triaged issue assigned to the PR author is currently linked.

Verification

  • make docs-fern — passed with 0 errors and 4 existing removed-SDK-page warnings.
  • uv run --locked pre-commit run --files docs/LIVE_DOCS.mdx docs/README.mdx fern/docs.yml fern/fern.config.json — passed.
  • git diff --check — passed.
  • Confirmed v0.23.0 and commit fb73f41b0fa2ef6c50c90d76f8b20533e4c9a51e contain the required Fern configuration and navigation files.
  • Confirmed the v0.22.0 snapshot commit is reachable from origin/develop.

A published Fern preview of the ref-backed versions was not run. GitHub CI is pending.

AI Assistance

  • No AI tools were used.
  • AI tools were used; a human reviewed and can explain every change (tool: OpenAI Codex; used for implementation, documentation, validation, and PR description drafting).

Checklist

  • I've read the CONTRIBUTING guidelines.
  • This PR links to a triaged issue assigned to me.
  • My PR title follows the project commit convention.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • I've noted any verification beyond CI and any checks I couldn't run.
  • I did not update generated changelog files manually.
  • I addressed all CodeRabbit, Greptile, and other review comments, or replied with why no change is needed.
  • @mentions of the person or team responsible for reviewing proposed changes.

@github-actions github-actions Bot added size: S status: needs triage New issues that have not yet been reviewed or categorized. size: XL and removed size: S labels Aug 12, 2026
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc
miyoungc force-pushed the codex/fresh-worktree-20260812 branch from 65724b9 to b541882 Compare August 13, 2026 15:58
@github-actions github-actions Bot added size: L and removed size: XL labels Aug 13, 2026
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@github-actions

Copy link
Copy Markdown
Contributor

@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc
miyoungc marked this pull request as ready for review August 13, 2026 22:15
@miyoungc miyoungc added documentation Improvements or additions to documentation CI labels Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI documentation Improvements or additions to documentation size: L status: needs triage New issues that have not yet been reviewed or categorized.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant