Adds frontmatter support for customizing sidebar labels independently from page H1 titles in the documentation generation process. #75068
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…README and update manifest generation to utilize sidebar label if present
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
Size Change: 0 B Total Size: 3 MB ℹ️ View Unchanged
|
juanmaguitar
added
[Type] Developer Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Closes #60782
Adds support for customizing sidebar/table of contents labels in the documentation generation process using frontmatter, while keeping the original H1 titles on pages.
Why?
Currently, the documentation generation process extracts the H1 heading from markdown files and uses it for both the page title AND the sidebar/breadcrumb navigation.
This creates a dilemma when we want to:
As noted in #60782, simply removing words like "reference" from the H1 would negatively impact SEO and make page titles confusing. This PR provides a solution that addresses both concerns.
How?
This PR modifies docs/tool/manifest.js to:
Testing Instructions