Skip to content

Automate Documentation Generation #163

@manojbajaj95

Description

@manojbajaj95

Description

Currently, documentation files like AGENTS.md and README.md are updated manually. We should set up an automated pipeline to generate and validate documentation.

Suggested approaches

  1. Setup a GitHub Actions workflow that automatically updates docs based on code comments using an extractor tool (e.g. Sphinx, pydoc).
  2. Validate AGENTS.md commands automatically via CI to ensure they stay up-to-date.
  3. Automatically update CLI documentation whenever authsome commands change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsenhancementNew feature or requestneeds-infoWaiting on reporter for more information

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions