Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI static checks for built-in documentation #117

Open
limbonaut opened this issue Feb 13, 2025 · 2 comments
Open

Add CI static checks for built-in documentation #117

limbonaut opened this issue Feb 13, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation github-actions

Comments

@limbonaut
Copy link
Collaborator

This will help verify whether we cover the API changes in documentation.

@limbonaut limbonaut added documentation Improvements or additions to documentation github-actions labels Feb 13, 2025
@limbonaut limbonaut moved this to Backlog in GDX Feb 13, 2025
@bruno-garcia
Copy link
Member

this can prob be added with danger.js

@limbonaut
Copy link
Collaborator Author

We'll need to build it first before we can verify it. The idea is to create a build, regenerate documentation with the built library, and check if there are any changes in the working tree. If so, it means, that the API changed, but the built-in docs were not updated to reflect those changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github-actions
Projects
Status: Backlog
Development

No branches or pull requests

2 participants