Skip to content

Correct UI Navigation Formatting in GitLab Documentation

Description

This merge request updates the GitLab documentation to ensure the > character in UI navigation paths is placed outside bold (**) formatting, per the GitLab Documentation Style Guide. The changes fix instances, as outlined in GitLab Issue #554157.

What does this MR do? Fixes bold formatting for UI navigation paths in the GitLab documentation, ensuring the > character is placed outside bold (**) formatting as per the GitLab Documentation Style Guide.

Briefly describe what this MR is about This MR updates documentation files to correct instances where the > character is incorrectly included within bold formatting for UI navigation paths (e.g., **Overview > Users** to **Overview** > **Users**). The changes cover 3-5 files, adhering to the contribution guidelines in GitLab Issue #554157.

Changes:

  • Modified files: <file_path_1>, <file_path_2>, <file_path_3> (e.g., doc/administration/settings.md, doc/user/overview.md, doc/feature.md).
  • Corrected X instances of misplaced > characters.
  • Validated Markdown rendering in GitLab.
  • Kept changes within the issue’s scope.

Related Issue: GitLab Issue #554157

Author's checklist

Reviewer's checklist

  • Docs metadata is present and up-to-date.
  • Appropriate labels (documentation, docs-only, type::maintenance, maintenance::refactor) are added.
  • Release milestone is set.
  • Content follows content topic type principles:
    • Headings are search-friendly and active (e.g., "Configure UI Navigation" instead of "Configuring UI Navigation").
    • Task steps, if any, are written as numbered lists.
  • If further topic type edits are needed, a follow-up issue with the docs-technical-debt label will be created.
  • Technical Writer review requested for non-blocking feedback.
  • Subject matter expert review requested if applicable.
  • Maintainer review requested.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading