Skip to content

fix(docs): promote page titles to h1 on two pages - #706

Open
feafel wants to merge 1 commit into
inkonchain:mainfrom
feafel:fix/pages-missing-h1
Open

feafel wants to merge 1 commit into
inkonchain:mainfrom
feafel:fix/pages-missing-h1

Conversation

@feafel

@feafel feafel commented Oct 11, 2026

Copy link
Copy Markdown

What

general/connect-wallet and build/tutorials/verify-smart-contract both start their body at ## instead of #, so they are the only two live content pages on the site with no <h1> at all.

Why

theme.config.mdx maps h1 to Nextra's PageTitle, so an # heading is what gives a page its title block. With ## the mapping never fires:

  • No <h1> in the document — search engines treat the missing top-level heading as a weak topic signal, and screen-reader users land in a heading tree that starts at level 2.
  • Visually inconsistent — the two pages render their titles as text-3xl section headings while every other page on the site gets the PageTitle treatment.

Every other page already follows the convention; these two are the outliers:

$ for p in /; do curl -sL https://docs.inkonchain.com | grep -oc '<h1'; done
page <h1> today after
/general/connect-wallet 0 Connect Wallet
/build/tutorials/verify-smart-contract 0 Verifying your Smart Contract

How

Promote the first heading on each page from ## to # (and drop a trailing space on one of them). Nothing else changes.

Verification

  • pnpm install --frozen-lockfile && pnpm run build on the patched tree: exit 0.
  • Built HTML now emits exactly one <h1> per page, with the expected text, and <title> is unchanged (Connect Wallet | Ink Docs, Verifying your Smart Contract | Ink Docs).
  • pnpm run lint:mdx (remark): clean.
  • No anchor anywhere in src/ links to #connect-wallet or #verifying-your-smart-contract, so no inbound links break.

Notes

Both pages started at '##', so they shipped with no <h1> at all while
every other page has one: nextra's h1 -> PageTitle mapping never fired,
so they also lost the page-title styling the rest of the site uses.

Verified against a local build of the patched tree: each page now emits
exactly one <h1> ('Connect Wallet', 'Verifying your Smart Contract') and
the <title> is unchanged. No anchor on the site links to either heading.
@feafel
feafel requested a review from a team as a code owner October 11, 2026 21:31
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.

2 participants