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

Use urfav Command struct directly to generate docsgen-cli #12706

Open
masih opened this issue Nov 19, 2024 · 0 comments · May be fixed by #12717
Open

Use urfav Command struct directly to generate docsgen-cli #12706

masih opened this issue Nov 19, 2024 · 0 comments · May be fixed by #12717
Assignees

Comments

@masih
Copy link
Member

masih commented Nov 19, 2024

The docsgen-cli builds binaries first, then executes them to get the usage, recursively for all sub commands. The process is less than optimal:

We already have Go structs for commands. We should be using those (along with urfav's built-in helper generators) to generate the docs. This way the docs generation would be far faster and significantly less error prone.

To do this however, we should refactor the cli package to make some commands exported so that they are accessible from the docsgen-cli script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🔎 Awaiting review
Development

Successfully merging a pull request may close this issue.

2 participants