docs(deploy-key): add synopsis and examples to deploy-key commands

Brendan Lynchrequested to merge
8263-add-synopsis-and-examples-to-deploy-key-commands into main

Description

Adds Long (Synopsis) fields and improved Examples to the deploy-key command and its subcommands, as part of the style guide audit identified in #8263 (closed).

Each Synopsis explains the command's default behavior, key flags, and when to use --repo to target another project, without repeating the Short description. The list Examples section is annotated with # comment lines describing each invocation, and a stale "SSH key" comment on the delete example was corrected to "deploy key".

Commands updated:

  • deploy-key
  • deploy-key delete
  • deploy-key get
  • deploy-key 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/.

Merge request reports