Documentation versions

These docs are versioned with Infrared. Each minor release of Infrared gets its own copy of the docs, so a team running 0.1 reads the docs for 0.1 while the next release is written.

Where the docs are today

Infrared has not released 0.1 yet. The docs you are reading are the 0.1 track: they describe what 0.1 will ship, and they change as 0.1 is built. That is why every page carries an "unreleased version" banner and the version menu shows 0.1 (next).

Version	Status	Source	URL
0.1 (next)	Unreleased, in progress	docs/	/

What happens at a release

At the 0.1 release, a maintainer snapshots the docs:

npm run docusaurus docs:version 0.1

This copies docs/ into versioned_docs/version-0.1/, copies the sidebar into versioned_sidebars/, and adds 0.1 to versions.json. Then, in the same change:

1. In docusaurus.config.ts, remove lastVersion: 'current', so the newest released version, 0.1, is served at the site root.
2. Change the current version's label to 0.2 (next) and its path to next. The unreleased banner stays on current.
3. Build with npm run build and fix any broken link the snapshot exposes.

From then on, docs/ is 0.2 (next), and versioned_docs/version-0.1/ is what 0.1 users read.

Rules

• Edit docs/ for the next version. New features, changed behaviour and new pages go in docs/.
• Never edit versioned_docs/ except to fix an error in a released version, such as a wrong command or a broken link. A fix that also applies to the next version goes in both places.
• Patch releases do not cut doc versions. 0.1.1 and 0.1.2 are documented by the 0.1 docs. If a patch changes behaviour a user relies on, note it on the page with the patch version.
• These docs describe the product. Installing, configuring, using and extending Infrared belongs here. How darkshift builds, hosts and operates its own infrastructure does not: that lives in darkshift's internal documentation, which is not versioned.