Repository navigation
build(versioning): wire Docusaurus versioning, short of the first snapshot - #108
Merged
Merged
Conversation
…pshot Nothing is versioned yet, so this adds only what the first snapshot needs to be one command later, and leaves the single-version site exactly as it was. `editCurrentVersion` sends a snapshot's "Edit this page" to docs/, so the stock link cannot invite a new feature into a frozen release. AGENTS.md step 2 no longer sets `lastVersion`: it defaults to the newest name in versions.json, so every later cut moves readers on its own. Step 1 now says to cut from an up-to-date master as the last step before the pull request, since any merge into docs/ makes an uncut snapshot stale and there is no refresh command, only delete and cut again. Step 3 holds the dropdown back until a snapshot exists: with none it renders as a lone link labelled after the development version, which reads as a release. Snapshots are cut for released versions only, so the navbar never offers a version the SDK has not tagged and a reader cannot install. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: jgjesdal <jostein@intellistream.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sets up Docusaurus versioning without cutting a snapshot, so the first release
is one command away and nothing unreleased is published in the meantime.
The published site is unchanged. No
/next/, no version routes, one searchindex,
v1.0badge still in the navbar. Final build: exit 0, zero warnings.docusaurus.config.jseditCurrentVersion: true— once a snapshot exists, its "Edit this page" pointsat
docs/instead of into the frozen copy, which the stock link would do andwhich AGENTS.md forbids (a snapshot takes corrections for its own release; a new
feature goes to
docs/). No effect until then; the current edit links stillresolve to
docs/<page>.v1.0badge stays, with a comment on when to swap it for the dropdown. Withzero snapshots
docsVersionDropdownrenders as a lone navbar link labelled afterthe development version — tested — which reads as a release claim.
lastVersionis deliberately absent.AGENTS.mdThe five snapshot steps now match how the plugin actually behaves:
master, as the last step before the PR. Anymerge into
docs/makes an uncut snapshot stale, and there is no refresh command,only delete and cut again.
lastVersion. It defaults to the newest name inversions.json(plugin-content-docs/lib/versions/version.js:154), so each latercut moves readers on its own and there is nothing to keep in step. Setting it
explicitly would pin readers to the first release forever.
get the versions that shipped.
build/search-index.json,build/next/search-index.json); search from a/next/page and confirm the hitstays under
/next/.New rule: snapshots are cut for released versions only, so the navbar never
offers a version the SDK has not tagged and a reader cannot install. Today that is
v0.2.0alone —mainhas been bumped to 0.4.0 without a release, so no number inbetween gets a snapshot.
Verified while prototyping
Cut and discarded throwaway snapshots to confirm the behaviour this encodes: two
snapshots coexist (
versions.jsonprepends, newest served at/, older at/X.Y/,docs/at/next/), each with its own search index and correctly prefixed URLs;the dropdown lists all versions; and with no snapshot the dropdown degrades to a
plain link. All builds clean.
Release day
npm run docusaurus docs:version 1.0, theversions.currentlabel from step 2, andthe dropdown swap.
🤖 Generated with Claude Code