search

urfave / cli

A simple, fast, and fun package for building command line apps in Go
https://cli.urfave.org
MIT License
22.37k stars 1.71k forks source link

Man page generation feature is not documented anywhere #1900

Open bartekpacia opened 6 months ago

bartekpacia commented 6 months ago

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.

dearchap commented 6 months ago

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 commented 6 months ago

@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 commented 6 months ago

Yeah, agreed 👍

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