Create glab CLI docs style guide

What does this MR do?

This MR adds a new style guide for glab CLI reference documentation at doc/development/documentation/cli_styleguide.md.

The style guide is intended for contributors who add or update glab commands in gitlab-org/cli, and for reviewers of CLI documentation merge requests. It covers:

  • How CLI documentation is generated from Go source via make gen-docs, and the role of the check_docs_update CI job.
  • GitLab version support requirements and SemVer versioning rules, and their implications for documentation.
  • Required page sections and the conventions for each, including the text.ExperimentalString and text.BetaString constants for experimental and beta features.
  • Front matter, environment variables, and cross-reference conventions.

The location for this page could fit under the other style guides (like REST API):

Screenshot_2026-04-10_at_15.33.45

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Brendan Lynch

Merge request reports

Loading