༺NIX༻Apr 10, 2024

I am begging developers of command line tools to simply write an example of the working command after the options.

reading a 1000 lines of documentation with a million -flags and -switches and then guessing how im supposed to use them is not fun. many many non coders want to use your program. Let us copy paste the working command and then edit to our needs

Show threadNelsonApr 10, 2024

@nix Have you seen https://tldr.sh/ ? I find it indispensable.

Of course you are correct, this should be included in all command line tool documentation by the authors/maintainers, rather than relying on a third party tool to address the problem.

tldr pages

Simplified and community-driven man pages

Show threadjosch
@skyfaller @nix Now I wonder why all the projects I maintain can be found on tldr.sh while at the same time I never even a single time received a issue report or pull request of the form "please provide examples" or "please simplify the man page". I wish the energy spent on maintaining tldr.sh would instead be spent to improve the actual documentation shipped by each project. These are FOSS projects and contributions are usually welcome.
Apr 10, 2024 at 10:05pmWeb
Show threadnfilipesApr 11, 2024
@josch @skyfaller @nix maybe people tend to favor one app to do all. It seems reasonable that tldr gets more attention because its use is to simplify man pages, not a specific app.
Maybe Devs could contribute to tldr by submitting their own examples.
Not blaming anyone here, I understand FOSS has issues with support and I thank anyone that does it.