fix: generate long desc and examples for root command

[dvdksn]

We're already calling loadLongDescription recursively, no need to range over the subcommands, otherwise we're skipping the root command.

[dvdksn]

@crazy-max can you help me look at these test failures? I have tried generating docs with this version in both cli and buildx and I don't see any issues. I can't quite figure out what's going wrong in these tests either.

[codecov-commenter]

Codecov Report

❌ Patch coverage is 72.22222% with 5 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
clidocstool.go	72.22%	2 Missing and 3 partials ⚠️

📢 Thoughts on this report? Let us know!

[crazy-max]

LGTM

[thaJeztah]

Sorry, I realise my question about --help somewhat distracted from the main issue; does this currently produce documentation for options/flags that are defined on the command? #53 (comment)

I recall now I went looking for flags, and noticing the --help as example, but currently there's no flags in the produced output (but probably because none are defined). If we want to use this for the root command, we probably need to make sure that it includes flags 🙈

[dvdksn]

@thaJeztah Aaah, I see now yes. Good callout. I just pushed a commit that adds two flags:

• --help (hidden, persistent flag)
• -H (dummy flag)

I looked at the options implementation in docker/cli and turns out adding --help as a hidden flag also removes it from the man fixtures (for subcommands as well, since it's a persistent flag), and interestingly, adds it for yaml fixtures (but as a hidden object 😆).

I think this change is appropriate since it mimics what we do in the core CLI.

0f4cffc#diff-9059958acfc03b30a2ff8fda8c5bb8403e63b17d7f32cdefe4611817db5cd191R57-R60

[thaJeztah]

Why were these changes needed? (Just curious as I couldn't immediately associate with the change in this PR)

[dvdksn]

Root commands for plugins are not generated;

• https://github.com/docker/cli-docs-tool/blob/main/clidocstool_md.go#L50-L54
• https://github.com/docker/cli-docs-tool/blob/main/clidocstool_man.go#L61-L65
• https://github.com/docker/cli-docs-tool/blob/main/clidocstool_yaml.go#L110-L114

[dvdksn]

Let's merge this

[crazy-max]

LGTM

[dvdksn]

I've used this version to generate markdown here:

• docker/cli: docker/cli@719f88e
• docker/buildx: cli docs tool v0.8.0 buildx#2565

I've also generated yaml (for docker/cli) here: docker/docs@b9ca733

[crazy-max]

Let's get this one in