You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Add github actions in each sub-repo to automatically update the docs/ repo with API updates #3
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:
Detect API changes (e.g., via modified files in cldk/ directory in python-sdk).
Generate updated API docs using mkdoc, or other language-specific doc generators.
Push changes to the docs/ repository, possibly via a bot account or deploy key.
Activity