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

Man page generation feature is not documented anywhere #1900

Open
bartekpacia opened this issue May 1, 2024 · 3 comments
Open

Man page generation feature is not documented anywhere #1900

bartekpacia opened this issue May 1, 2024 · 3 comments
Labels
kind/documentation describes a documentation update

Comments

@bartekpacia
Copy link
Member

One of the bullet points listing cli's features in README says: "man and markdown format documentation generation".

Where is this feature documented? I could not find it.

@bartekpacia bartekpacia added the kind/documentation describes a documentation update label May 1, 2024
@dearchap
Copy link
Contributor

dearchap commented May 5, 2024

That is the v2 docs. v2 has the feature. Its probably not documented very well but its there

https://github.com/urfave/cli/blob/v2-maint/docs.go#L19

@meatballhat
Copy link
Member

@bartekpacia In support of making the core library smaller and only using stdlib dependencies, we decided to move these capabilities out into urfave/cli-docs but, to your point, this relationship is not well-documented 😬. WDYT about making this issue a child-of/tracked-by #1891 ?

@bartekpacia
Copy link
Member Author

bartekpacia commented May 5, 2024

Yeah, agreed 👍

btw I already updated v3 readme on master branch to reflect this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation describes a documentation update
Projects
None yet
Development

No branches or pull requests

3 participants