Documentation versions

These docs come in one version per release track. A track is a minor version of Infrared, such as 0.1 or 0.2. Pick yours from the version menu at the top of the page; every release in that track (0.1.0, 0.1.1, 0.1.2 and so on) is described by the same docs.

The versions

Version	What it covers	Where it lives
0.1	Infrared 0.1.0 and its patch releases. The default.	/
0.2 (next)	What is being built for the 0.2 track. Unreleased, and it changes as 0.2 is built.	/next/

Each track's release notes list every release in it, newest first, with how to install it and how to upgrade to it.

Patch releases

A patch release (0.1.1, 0.1.2) does not get docs of its own. Its track's docs are updated in place and published again:

1. Add the release to the top of that track's release notes, with its date, what changed and any upgrade step.
2. If the patch changes something a reader relies on, correct the page that describes it, and say which patch changed it ("Since 0.1.2, ...").
3. Edit the track's copy (versioned_docs/version-0.1/). If the same correction applies to the next track, make it in docs/ too.

Pre-releases (-rc.N) are not documented as releases. They are builds of the next track and are described by its unreleased docs.

A new track

When a new minor version is released, its docs are cut from docs/:

npm run docusaurus docs:version 0.2

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

1. In docusaurus.config.ts, set lastVersion to the new track, so it is served at the site root.
2. Label the new track 0.2 with no banner, and relabel current as the next track (0.3 (next), at next).
3. Keep the earlier tracks that people still run; remove a track's docs once no supported install runs it.
4. Build with npm run build and fix any link the cut breaks.

From then on, docs/ is the next track.

Rules

• Edit docs/ for the next track. New features, changed behaviour and new pages go there.
• Edit a released track's copy only for that track's patch releases and corrections, such as a wrong command or a broken link.
• These docs describe the product. Installing, configuring, using and extending Infrared belongs here. How darkshift builds and runs its own infrastructure does not.
• Don't edit generated pages. The AgentRole and AgentWorkflow pages and the catalog page under docs/agents/ are generated from the catalog in infrared-operator (api/catalog/) with npm run gen:agents.