docs(securefile): add synopsis and examples to securefile commands

Description

Adds Long (Synopsis) fields and improved Examples to the five securefile 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. The Examples section on each page is annotated with # comment lines that describe the intent of each invocation.

Positional argument placeholders are updated from camelCase (<fileID>, <fileName>, <inputFilePath>) to kebab-case (<id>, <name>, <path>), matching the convention used in other glab commands and the style guide.

Commands updated:

  • securefile create
  • securefile download
  • securefile get
  • securefile list
  • securefile remove

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

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

Loading