docs(config): add synopsis and improve examples for config commands

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

Description

Adds and refines the Long (Synopsis) fields and Examples for the config command family, as part of the style guide audit identified in #8263 (closed).

  • config get gains a Synopsis describing the lookup order and the --global / --host flags.
  • config edit and config set Synopses no longer repeat their Short description, and inline tokens (flag names, file paths, commands) are now wrapped in backticks per the style guide.

Content follows the documentation style guide and the GitLab CLI (glab) documentation style guide.

Commands updated:

  • config get
  • config edit
  • config set

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