Docs Versioning Guide

This guide explains how to enable and maintain versioned documentation for Infowebplus.

Current status

• The Docusaurus project is currently running with a single “current” version of the docs.
• No versioned docs have been generated yet (versioned_docs/ and versions.json are absent).

This is a good default while the product is still evolving quickly.

When to introduce versions

Add a new docs version when:

• You introduce breaking changes in the main Infowebplus application.
• You need to maintain documentation for both older and newer releases concurrently.

Examples:

• Major changes to the quote API.
• Significant changes in Sanity schemas or environment variables.

Creating the first version

From the root of this documentation project:

npx docusaurus docs:version 1.0.0

This will:

• Copy the current docs into versioned_docs/version-1.0.0/.
• Generate versioned_sidebars/version-1.0.0-sidebars.json.
• Create or update versions.json.

Commit these files so they are deployed with the site.

Keeping versions aligned with releases

Recommended workflow:

1. Before cutting a new app release:

   • Update docs so that current reflects the upcoming release.

2. Run:

   npx docusaurus docs:version <new-version>

3. Deploy the new app version and docs together.

TODO

Define a concrete policy for how app releases (for example, 1.0.0, 1.1.0) map to docs versions and document that policy here once agreed.