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

Migrate behaviour to go generate ./... #8

Open
ChausseBenjamin opened this issue Dec 27, 2024 · 0 comments
Open

Migrate behaviour to go generate ./... #8

ChausseBenjamin opened this issue Dec 27, 2024 · 0 comments

Comments

@ChausseBenjamin
Copy link

In most cases, end-users don't need to be capable of generating documentation for the software they use. They only need it to be accessible somewhere on their machine.

Following that train of though, it feels a bit wasteful to include a text generation as part of any application only for the sake of generating documentation.

However, Go has tooling builtin for generating text/code which can be run outside of a compiled go program: go generate ./.... What would be the sentiment towards making cli-docs more of a code/text generator instead of something that gets compiled into an application?

A good example of code generation being used is 99designs/gqlgen which generates method templates for an API implementation. In this case, man pages and markdown could get generated instead of code.

I know this is a big philosophy change which might not correlate with your vision. I'm just throwing the idea out there as it occurred to me :)

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

No branches or pull requests

1 participant