Skip to content

Versioned documentation #954

Description

@jannfis

Is your task related to a problem? Please describe.

Right now, the documentation at https://argocd-agent.readthedocs.io renders from the main branch, and might include unreleased features or procedures. This can lead to confusion, if people running the latest release and trying to do things not yet released.

Describe the solution you'd like

We should have versioned documentation, where the user can select the version of the docs to view via a dropdown or similar user interface.

The default documentation should be the one for the current stable release, instead of latest (which usually points to main).

Describe alternatives you've considered

Alternatively, we could mark things in the documentation with a version identifier. But this can be hard to read, hard to maintain and overall lead to a worse docs experience.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/taskTasks, chores, etc

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions