Skip to content

docs content: page titles carry no search intent — median 14 characters, 325 of 403 under 20 #12237

Description

@os-zhuang

One-liner

Doc titles are bare feature nouns — Objects, Fields, Actions, Documentation. Median length is 14 characters; 325 of 403 are 20 characters or less. With | ObjectStack appended a typical SERP title is ~30 characters against a ~60-character budget, and the half that is ours carries no term anyone searches for.

Measured

title length:  n=403  median=14  max=50   <=20 chars: 325
e.g.  "Objects" · "Fields" · "Actions as Tools" · "Documentation" · "AI Overview"

Expected

Adopt one rule and apply it: <primary keyword> — <qualifier>, 50–60 characters including the | ObjectStack suffix. The primary keyword is the phrase a developer would type, not our internal noun:

now shape to aim for
Object Metadata Object metadata: define objects, fields and relationships
Actions as Tools Expose actions as MCP tools for AI agents
Documentation ObjectStack documentation: metadata-driven app framework

⚠️ This is maintainer-voice territory. The PR must open with the rule plus the full 403-row before/after table so the pattern can be judged in one read, and it stays open for maintainer review — do not self-merge it. If the rule is rejected, only the table is thrown away, not per-file work.

Note the Sidebar title and the SEO title do not have to be the same string — check whether content/docs/**/meta.json or the frontmatter can carry a separate short label for navigation before lengthening every sidebar entry.

Acceptance

  • one written rule, in the PR body, with the before/after table
  • sidebar navigation still reads cleanly (short labels preserved, by whatever mechanism)
  • no title exceeds 60 characters including the site suffix
  • pnpm check:doc-anchors and the link checker stay green

Source

Found in an SEO review of the docs site (apps/docs) run on 2026-08-25, measured against the local dev server and against production. The canonical origin is https://objectstack.ai — maintainer ruling recorded in #10659:

这个仓的文档站规范 URL 是 https://objectstack.ai

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions