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

Improvement: auto-generate docs/env.md #377

Open
dselans opened this issue Sep 29, 2024 · 0 comments
Open

Improvement: auto-generate docs/env.md #377

dselans opened this issue Sep 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Eligible for Hacktoberfest PRs help wanted Extra attention is needed

Comments

@dselans
Copy link
Contributor

dselans commented Sep 29, 2024

docs/env.md is intended to show all of the env vars that plumber supports but it has not been kept up.

Would be great to auto-generate the list so that we do not have to remember to try to keep it up to date.

I'm imagining a workflow in Github that looks at all available env vars and generates a doc for it.

Important bit would be to generate it deterministically and have it be idempotent - as in, running the generator over and over should produce same result.

@dselans dselans added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed hacktoberfest Eligible for Hacktoberfest PRs labels Sep 29, 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 good first issue Good for newcomers hacktoberfest Eligible for Hacktoberfest PRs help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant