Versions
Freeze the documentation for a release you still support.
Versions
Section titled “Versions”A version is your documentation as it was for a release: v1, v2, beta.
What a version actually is
Section titled “What a version actually is”A ref in your own repository. Cutting v1 creates a branch at whatever is
published today; building it reads that branch exactly as the live site reads
the published one.
There is no second content model. A version is something you can check out.
Cutting one
Section titled “Cutting one”Cut a version when work on the next one starts. The common sequence is: v2
work begins, so v1 is cut and frozen.
A version carries a name, a label, the git ref it was cut at, and a deprecation flag.
A cut version is frozen
Section titled “A cut version is frozen”Warning
Editing an old version is not offered. The writer publishes to the live branch only.
This is stated plainly rather than half-built. The common case is cutting v1
when v2 starts and never touching v1 again, and a half-working edit path
would be worse than an honest refusal.
If you must correct a frozen version, do it in your repository on that ref and rebuild.
Deprecation
Section titled “Deprecation”Mark a version deprecated and its pages carry a banner telling readers it is no longer current, with a link to the current version.
Deprecating is not deleting. The pages stay, the URLs stay, and search engines keep the ones they have indexed.
The version switcher
Section titled “The version switcher”Readers switch versions from the header. Where an equivalent page exists in the target version, the switch keeps their place. Where it does not, it goes to that version’s home page rather than to a 404.
Free has one
Section titled “Free has one”Free includes one live version of the site. Versions are a Pro capability. See Plans.