Skip to content

docs: add h1 metadata to examples#168

Merged
jaysin586 merged 1 commit into
mainfrom
codex/seo-h1-cleanup
Jun 7, 2026
Merged

docs: add h1 metadata to examples#168
jaysin586 merged 1 commit into
mainfrom
codex/seo-h1-cleanup

Conversation

@jaysin586

Copy link
Copy Markdown
Contributor

Summary

Adds missing context-driven H1 metadata to the docs example article pages so the SEO cleanup matches the example-page pattern used elsewhere in the docs site.

Changes

📚 Documentation

  • Adds seo.h1 metadata to every /docs/examples/* article page that sets SEO context.
  • Aligns docs example pages with the existing /examples/* detail page H1 metadata pattern.

🧪 Testing

  • Verified all example detail pages with SEO context define seo.h1.
  • Verified pnpm --filter docs check passes.
  • Verified trunk check passes.

Commits

  • 1ad3434 docs: add h1 metadata to examples

@jaysin586 jaysin586 added the skip-publish This is something important, but we dont want to publish it label Jun 7, 2026
@jaysin586 jaysin586 self-assigned this Jun 7, 2026
@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6831660e-eb61-4b76-9f7e-e05ed59c1e80

📥 Commits

Reviewing files that changed from the base of the PR and between f45dfb0 and 1ad3434.

📒 Files selected for processing (11)
  • docs/src/routes/docs/examples/api-caching/+page.svx
  • docs/src/routes/docs/examples/async-decorator/+page.svx
  • docs/src/routes/docs/examples/async-fetching/+page.svx
  • docs/src/routes/docs/examples/computed-values/+page.svx
  • docs/src/routes/docs/examples/configuration/+page.svx
  • docs/src/routes/docs/examples/database-caching/+page.svx
  • docs/src/routes/docs/examples/monitoring/+page.svx
  • docs/src/routes/docs/examples/multi-tenant/+page.svx
  • docs/src/routes/docs/examples/rate-limiting/+page.svx
  • docs/src/routes/docs/examples/service-class/+page.svx
  • docs/src/routes/docs/examples/sessions/+page.svx

📝 Walkthrough

Walkthrough

This PR adds explicit SEO H1 title metadata to ten documentation example pages by setting seo.h1 with descriptive page titles. Each page receives a single-line update in its SEO configuration block, following a consistent pattern across API caching, async patterns, configuration, database, monitoring, multi-tenant, rate limiting, service class, and session storage examples.

Changes

Documentation SEO H1 Titles

Layer / File(s) Summary
Add explicit H1 titles to documentation example pages
docs/src/routes/docs/examples/api-caching/+page.svx, docs/src/routes/docs/examples/async-decorator/+page.svx, docs/src/routes/docs/examples/async-fetching/+page.svx, docs/src/routes/docs/examples/computed-values/+page.svx, docs/src/routes/docs/examples/configuration/+page.svx, docs/src/routes/docs/examples/database-caching/+page.svx, docs/src/routes/docs/examples/monitoring/+page.svx, docs/src/routes/docs/examples/multi-tenant/+page.svx, docs/src/routes/docs/examples/rate-limiting/+page.svx, docs/src/routes/docs/examples/service-class/+page.svx, docs/src/routes/docs/examples/sessions/+page.svx
Sets seo.h1 field with specific page titles in the SEO context block for each example documentation page. Pattern: seo.h1 = { title: '[Example Name]' }.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • humanspeak/memory-cache#167: Introduces async-aware single-flight caching with @cached decorator and substantially adds Async Decorator docs example, which intersects with this PR's SEO metadata updates for that page.

Suggested labels

documentation

Poem

📚 Ten pages gain their H1 crown,
SEO metadata scattered down,
Titles bright, consistent and clear,
Search results now appear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add h1 metadata to examples' clearly and concisely describes the main change—adding h1 SEO metadata to documentation example pages.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose, changes made, and testing verification for the h1 metadata additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/seo-h1-cleanup

Comment @coderabbitai help to get the list of available commands and usage tips.

@jaysin586 jaysin586 merged commit dd83328 into main Jun 7, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-publish This is something important, but we dont want to publish it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant