Skip to content

Page-specific meta descriptions on per-app docs sites #81

@rubenvdlinde

Description

@rubenvdlinde

Part of #75 (SEO epic).

What

Hand-write the <meta name="description"> for the highest-traffic 5–10 pages on each per-app docs site. Currently most pages auto-generate the description from the first paragraph, which is fine for thin pages but wasteful on long-form tutorials and reference pages.

Why

Meta descriptions don't directly rank but they drive CTR. The auto-generated descriptions on per-app docs sites either truncate awkwardly mid-sentence or repeat the first sentence verbatim ("Open Register is a versatile system for creating..."). Hand-crafted descriptions that answer the search intent + include the keyword variant pull more clicks at the same rank.

Scope

Per site, target ~10 high-traffic pages (homepage, install, API reference index, top tutorials). Total fleet: ~170 pages.

Approach

Add a description: field to the frontmatter of each target page:

---
title: Schema management
description: How to design, validate, and version-control register schemas in OpenRegister. JSON Schema, Schema.org imports, GGM mapping, REST + GraphQL exposure.
---

Docusaurus picks it up automatically and emits <meta name="description" content="..."> and <meta property="og:description" content="...">.

Guidance

  • 140–160 chars (Google truncates around 160)
  • Lead with the value prop, not the marketing tagline
  • Include the canonical search term verbatim once
  • Avoid em-dashes per Conduction writing rules

Acceptance

  • Top 5–10 pages per site have hand-written descriptions
  • All descriptions <= 160 chars
  • Validator: validate-ai-baseline check that no two pages share a description (no copy-paste)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions