Skip to content

Fix code quality REST sidebar label#44437

Open
hesreallyhim wants to merge 1 commit into
github:mainfrom
hesreallyhim:fix/code-quality-sidebar-title
Open

Fix code quality REST sidebar label#44437
hesreallyhim wants to merge 1 commit into
github:mainfrom
hesreallyhim:fix/code-quality-sidebar-title

Conversation

@hesreallyhim
Copy link
Copy Markdown

@hesreallyhim hesreallyhim commented May 24, 2026

Why:

Closes: #44436

What's being changed (if available, include any code snippets, screenshots, or gifs):

In the REST API docs, the left sidebar/navigation table of contents displays code-quality instead of Code quality, like Code scanning. This is due to a missing shortTitle in the YAML front-matter for that entry. I have added the appropriate shortTitle and adjusted the title to match the other index.md entries in sibling directories.

BEFORE:

Screenshot 2026-05-24 at 6 54 40 AM

and:

Screenshot 2026-05-24 at 8 19 32 AM

AFTER:

Screenshot 2026-05-24 at 7 38 57 AM Screenshot 2026-05-24 at 8 19 32 AM

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copilot AI review requested due to automatic review settings May 24, 2026 12:30
Copilot AI reviewed May 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the REST docs page frontmatter for the code quality section to use a clearer, user-facing title while preserving the ability for the title to differ from the filename.

Changes:

  • Replaced the generic title with a more descriptive page title.
  • Added shortTitle for navigation/UI contexts.
  • Removed an extra trailing blank line in the frontmatter block.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label May 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 24, 2026

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
rest/code-quality/index.md fpt
 fpt

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

REST docs sidebar table of contents - "Code quality" shows slug-style code-quality

2 participants

@hesreallyhim