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.

Sign up for GitHub

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

Jump to bottom

[FEAT] Autogenerate wasmcloud reference documentation on wasmcloud release #798

Open
brooksmtownsend opened this issue Jan 15, 2025 · 0 comments
Open

[FEAT] Autogenerate wasmcloud reference documentation on wasmcloud release #798

brooksmtownsend opened this issue Jan 15, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@brooksmtownsend
Copy link
Member

The wasmcloud reference docs page is generated by using wasmcloud --help-markdown which automatically documents all subcommands, flags and environment variables for the wash CLI. Currently, though, we have to do this manually and copy the CLI reference back to this page. It would be great to augment the action in the wasmCloud repository to run a workflow here once a new version of wasmcloud is released, which docs maintainers can review and approve for quick updates.

Similar to #797
@brooksmtownsend brooksmtownsend added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jan 15, 2025
@brooksmtownsend brooksmtownsend moved this to Ready for Work in wasmCloud Roadmap Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
wasmCloud Roadmap
Status: Ready for Work
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brooksmtownsend