Skip to content

Add github actions in each sub-repo to automatically update the docs/ repo with API updates #3

@rahlk

Description

@rahlk

Is your feature request related to a problem? Please describe.
Keeping the docs/ repository up-to-date with API changes across multiple sub-repos is currently a manual process. This can lead to outdated or inconsistent documentation, especially when API updates are frequent.

Describe the solution you'd like
Implement GitHub Actions in each sub-repo to automatically trigger updates to the central docs/ repository whenever API changes are made. This should include generating updated API documentation and pushing it to the docs/ repo to ensure consistency.

Describe alternatives you've considered

  • Manually updating the docs/ repository after every API change, which is time-consuming and forgetfulness-prone.

Additional context
The GitHub Action workflow could be configured to:

  1. Detect API changes (e.g., via modified files in cldk/ directory in python-sdk).
  2. Generate updated API docs using mkdoc, or other language-specific doc generators.
  3. Push changes to the docs/ repository, possibly via a bot account or deploy key.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions