Enhance Readability and Structure of Docs Metadata YAML#39403
Enhance Readability and Structure of Docs Metadata YAML#39403NirajDN wants to merge 1 commit intogithub:mainfrom
Conversation
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
The line appears to be incomplete. The allows key is cut off and missing its value, which will cause YAML parsing errors.
| allows | |
| allows: [] |
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 linksNote: 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. |
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):
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: