Skip to content

Conversation

@NirajDN
Copy link
Contributor

@NirajDN NirajDN commented Jul 15, 2025

Why:

This PR improves the maintainability and clarity of the GitHub Help Documentation YAML configuration by removing duplicate redirects, organizing navigation, and improving formatting. These changes help contributors better navigate and maintain the docs config.

Closes: N/A (no existing issue; this is an optimization and cleanup)

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

  • Removed redundant redirect entries from the redirect_from list to reduce clutter.
  • Grouped and sorted redirects and navigation children for readability.
  • Added comments to the YAML to aid future maintenance.
  • Improved formatting and indentation consistency.

These changes are entirely behind the scenes in the YAML configuration file that controls the docs navigation and redirects.

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 15, 2025
@github-actions
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.

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
index.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14

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

🤖 This comment is automatically generated.

@NirajDN NirajDN closed this Jul 15, 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