Skip to content

Documentation versioning #4451

@kprokofi

Description

@kprokofi

🚩 Problem

Our current documentation setup does not support versioning, which causes confusion and usability issues for users working with different releases of OTX.

As the API evolves, documentation for the latest version may no longer match older stable releases. This leads to broken examples, outdated instructions, and difficulty in onboarding users who depend on version-specific behavior.


💡 Proposal

Implement proper documentation versioning to support multiple releases and ensure users can access accurate and relevant information based on the version they are using.

Goals:

  1. Enable versioned builds
    Host documentation for each released version (e.g., latest, v2.2, v2.1, v1.0) using tools like sphinx-multiversion or a similar approach compatible with our existing build system.

  2. Default to the latest stable version
    The docs should default to the most recent stable release, not the development branch, to reduce friction for most users.

  3. Add a version switcher UI
    Include a dropdown in the top navigation bar to allow users to easily switch between documentation versions.

Metadata

Metadata

Labels

DOCImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions