Skip to content

Enhance Readability and Structure of Docs Metadata YAML #39403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

NirajDN
Copy link
Contributor

@NirajDN NirajDN commented Jul 19, 2025

Why:

This PR improves the readability, maintainability, and structure of the GitHub Docs metadata YAML configuration. It removes redundant entries, consolidates related keys, and optimizes formatting for better clarity and easier future updates.

Closes: N/A (no existing issue, but improves code quality and maintainability)

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

  • Removed duplicated or unnecessary keys to reduce clutter.
  • Standardized formatting and indentation for consistency.
  • Grouped related settings logically for better structure.
  • Improved comments and placeholder text for clarity.
  • Ensured all keys follow consistent naming conventions.

These changes do not affect functionality but enhance the quality of the codebase and make it easier for contributors to maintain and extend the configuration.

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 Copilot AI review requested due to automatic review settings July 19, 2025 22:05
Copy link
Contributor

@Copilot 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

This PR improves the readability and maintainability of the GitHub Docs YAML configuration file by restructuring the content with better formatting, consistent indentation, and logical grouping. The changes focus on enhancing code quality without affecting functionality.

Key changes include:

  • Converted single-line strings to multi-line YAML format using > and >- operators for better readability
  • Added consistent spacing and section breaks between major configuration groups
  • Standardized quote usage around string values containing special characters

The fine-grained token must have the following permission set
no_permission_sets: >
The fine-grained token does not require any permissions.
allows
Copy link
Preview

Copilot AI Jul 19, 2025

Choose a reason for hiding this comment

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

The line appears to be incomplete. The allows key is cut off and missing its value, which will cause YAML parsing errors.

Suggested change
allows
allows: []

Copilot uses AI. Check for mistakes.

Copy link
Contributor

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.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 19, 2025
@NirajDN NirajDN closed this Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant