docs(milestone): add synopsis and examples to milestone commands
Description
Adds Long (Synopsis) fields and improved Examples to the milestone
command and its five subcommands, as part of the style guide audit
identified in #8263 (closed).
Each Synopsis explains the command's default behavior, key flags, and
the relationship between --project and --group. The Examples section
on each page is annotated with # comment lines that describe the
intent of each invocation.
The Use lines for delete, edit, and get are updated to use the
positional argument notation defined in the style guide
(<id> for required, [<id>] for optional). The matching subcommand
assertions in milestone_test.go are updated accordingly.
Commands updated:
milestonemilestone createmilestone deletemilestone editmilestone getmilestone list
Content follows the documentation style guide and the GitLab CLI (glab) documentation style guide.
Related issues and merge requests
Documentation
If this MR adds or updates CLI command documentation, follow the conventions in the
GitLab CLI (glab) documentation style guide,
run make gen-docs, and commit the updated files in docs/source/.