Documentation versions

Sim2Bot currently publishes one documentation line from main. That is the right model while the SDK is alpha and has no supported historical releases.

When to enable versioning

Enable a version selector after the first public SDK release when all three are true:

1. sim2bot packages have immutable version tags such as v0.2.0.
2. Users may remain on an older SDK while a newer release exists.
3. The API reference differs enough that latest alone could mislead users.

Until then, a selector would imply support guarantees that do not exist yet.

Recommended URL model

URL	Meaning
/latest/	Documentation built from main; may describe unreleased work.
/stable/	Alias for the newest supported SDK release.
/0.2/	Frozen documentation for the latest 0.2.x release.

Once versioning is enabled, the in-app Documentation window should point to /stable/ in production and to the local MkDocs server during development.

Recommended release workflow

Use mike with Material for MkDocs when the first stable version is ready:

pip install mike
mike deploy --push --update-aliases 0.2 stable
mike set-default --push stable

For unreleased documentation:

mike deploy --push latest

At release time:

1. Merge validated staging work into main.
2. Run SDK tests, documentation example checks, and the strict MkDocs build.
3. Tag the SDK release.
4. Deploy its major/minor documentation version and update stable.
5. Verify the version selector, search, source links, and in-app iframe.

Current decision

Do not add mike to production dependencies or enable its version selector yet. This page records the exact migration path so versioning can be activated without redesigning the documentation later.