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 documentation header to all our bin/ utilities + auto-generate overall doc #130

Open
AliSoftware opened this issue Oct 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@AliSoftware
Copy link
Contributor

Internal ref: p1729815426023749/1729802878.523709-slack-CC7L49W13

To better document all of the utilities we make available via this plugin, we should:

  • Adopt the convention of adding some docuemtation lines at the start of each script
  • Have a script that take all the bin/* scripts in the plugin, extracts the doc header, and generates a README from it
    • We could then maybe have a Danger check that runs the script on CI and warns if it doesn't match the current README checked out in the repo, suggesting the PR author to run the script locally themselves and commit the changes
    • (we could also consider to have the CI push the generated README itself instead of asking the PR author to push it, but in general I'm not super keen to have CI push commits if we can avoid it)
@AliSoftware AliSoftware added the documentation Improvements or additions to documentation label Oct 25, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant