Give reference listing pages a real h1 - #114
Closed
GuanzhouSong wants to merge 1 commit into
Closed
Conversation
The MQL reference index, type, and category pages used an h2 as their top-level heading, leaving those pages with no h1 at all. Individual reference entries are fine - their h1 comes from the compiled markdown (each entry in documentdb/docs starts with an h1 title) - so only the three listing pages change. Styling classes are unchanged; the _metadata.description.md blurbs rendered below are plain paragraphs with no headings, so no heading-order conflict is introduced.
Contributor
Author
|
Combined into #120. |
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
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
The MQL reference index, [type], and [type]/[category] pages render their top-level heading as
<h2>, so those pages have noh1at all — a small but real accessibility and SEO defect (screen-reader landmark navigation and search snippets both key offh1).Promotes the three headings to
h1with identical styling classes.Validation
[name]) are untouched — verified againstdocumentdb/docscontent that each entry's markdown starts with an# h1title (e.g.api-reference/operators/accumulators/$avg.md), so they already have a proper h1 via the Markdown renderer._metadata.description.mdfiles rendered under these headings (root, operators, commands, category level) — all plain paragraphs, no headings, so promoting the page title introduces no heading-order conflicts.🤖 Generated with Claude Code
https://claude.ai/code/session_01XGMeNSmhAgmqzkdc7cQQgf