Examine that docs/command-reference.md has all the flags

[AkihiroSuda]

https://github.com/containerd/nerdctl/blob/main/docs/command-reference.md

Missing:

• nerdctl run --log-driver=none
  ...

Ideally this document should be auto-generated

[PranshuSrivastava]

/assign

[PranshuSrivastava]

@AkihiroSuda when exactly should this be autogenerated? on a new release? or when a new command is merged to main?

[AkihiroSuda]

@AkihiroSuda when exactly should this be autogenerated? on a new release? or when a new command is merged to main?

Probably latter

[PranshuSrivastava]

Well I can think of only two ways in which we can enforce this, first is, to somehow add this as a test in the github pipeline so that whenever there is a new pr for a command, the author is prompted to also update the docs for it, or we take the code and feed into some ai model that can generate the documentation accordingly. But the second option could lead to many mistakes and also would be a pretty cumbersome process.
What do you think?

[AkihiroSuda]

https://pkg.go.dev/github.com/spf13/pflag#FlagSet.SetAnnotation should be used to annotate flag descriptions.

These descriptions should not be shown in --help as they would be too verbose.
Something like make docs should consume those annotations to generate docs/command-reference.md.
CI should fail when the file is out of sync.

[PranshuSrivastava]

annotating flag descriptions with this library is not a good idea because these annotations do not show up when the help command is called. So we will need to have both descriptions and annotations for a flag, or I can just compile the descriptions using the make command and generate the md file with that.