Skip to content

Documentation for agentic workflow should be versioned #3175

Closed as not planned

Description

@Mossaka

The documentation for the agentic workflow should support versioning to improve clarity for users across different releases.

Requirements:

  • By default, the documentation should display information relevant to the latest released version.
  • If a user is utilizing gh-aw directly from the source tree (i.e., an unreleased version), the documentation should also provide a way to access (and highlight) that unreleased version.

Benefits include avoiding confusion and ensuring users always see documentation that matches the features and behaviors in the version of gh-aw they are using.

Activity

  1. pelikhan commented on Nov 4, 2025

    @pelikhan
    Collaborator
    • configure astro starlight docs to use https://github.com/HiDeoo/starlight-versions
    • only version per minor revision (0.27, 0.28)...
    • update the documentation instructions such that when editing a file in the docs, one first creates a copy for the previous minor release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions