Skip to content

Give reference listing pages a real h1 - #114

Closed
GuanzhouSong wants to merge 1 commit into
documentdb:mainfrom
GuanzhouSong:fix/reference-page-h1
Closed

Give reference listing pages a real h1#114
GuanzhouSong wants to merge 1 commit into
documentdb:mainfrom
GuanzhouSong:fix/reference-page-h1

Conversation

@GuanzhouSong

Copy link
Copy Markdown
Contributor

What

The MQL reference index, [type], and [type]/[category] pages render their top-level heading as <h2>, so those pages have no h1 at all — a small but real accessibility and SEO defect (screen-reader landmark navigation and search snippets both key off h1).

Promotes the three headings to h1 with identical styling classes.

Validation

  • Individual reference entry pages ([name]) are untouched — verified against documentdb/docs content that each entry's markdown starts with an # h1 title (e.g. api-reference/operators/accumulators/$avg.md), so they already have a proper h1 via the Markdown renderer.
  • Checked the _metadata.description.md files rendered under these headings (root, operators, commands, category level) — all plain paragraphs, no headings, so promoting the page title introduces no heading-order conflicts.
  • The reference layout sidebar contains links only, no competing headings.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XGMeNSmhAgmqzkdc7cQQgf

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.
@GuanzhouSong

Copy link
Copy Markdown
Contributor Author

Combined into #120.

@GuanzhouSong
GuanzhouSong deleted the fix/reference-page-h1 branch July 30, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant