Skip to content

Automated SEO fixes: resolve multiple H1 on /api and trim SSH meta description#258

Draft
petradonka wants to merge 1 commit into
mainfrom
automated-seo-fixes-20260626
Draft

Automated SEO fixes: resolve multiple H1 on /api and trim SSH meta description#258
petradonka wants to merge 1 commit into
mainfrom
automated-seo-fixes-20260626

Conversation

@petradonka

Copy link
Copy Markdown
Collaborator

Summary

Ran the docs-seo-audit skill against the live docs.warp.dev sitemap (338 pages scanned, 9 issues found: 8 warnings, 1 info, 0 errors). This PR fixes the two clear, low-risk issues. The remaining warnings are intentionally-short titles already documented as exceptions in the skill, plus one borderline title flagged for human review (see below).

Changes

src/pages/api.astro

  • Demoted the server-rendered endpoint-index spec title from <h1> to <h2>, and the per-endpoint headings from <h2> to <h3>.
  • The /api page now has a single <h1> (Warp & Oz HTTP API reference), resolving the multiple_h1 warning while preserving a clean h1 > h2 > h3 outline. This is a semantic-only change to a visually-hidden, crawler-facing section.

src/content/docs/terminal/warpify/ssh.mdx

  • Trimmed the meta description from 162 to 159 characters (to get afor a) so it is no longer truncated in search results. Wording and keywords are unchanged otherwise.

Not changed (intentional)

  • 6 title_too_short warnings are allowlisted exceptions per the skill (intentionally short titles where sidebar/section context disambiguates): changelog/index.mdx, guides/index.mdx, reference/cli/artifacts.mdx, terminal/windows/tab-configs.mdx, terminal/windows/tabs.mdx, terminal/windows/split-panes.mdx.
  • agent-platform/cloud-agents/agents.mdx (Cloud agents | Warp, 19/20 chars) — flagged for human review rather than auto-renamed. It's a proper feature name only 1 char under the soft threshold, has sidebar context (Oz Cloud Agents & Orchestration > Agents), and any rename risks colliding with the sibling Cloud agents overview page. Per the skill's caution against over-eager prefixing, it was left as-is.

Validation

  • Confirmed the /api page now has exactly one <h1> and balanced h1 > h2 > h3 heading tags.
  • Confirmed the SSH description is 159 chars (≤160).
  • A full npm run build was not run because dependencies are not installed in this environment; changes are syntactically trivial (a YAML string trim and balanced heading-tag swaps).

Conversation: https://app.warp.dev/conversation/cfa2469b-c80c-41c8-b6c9-1cc38cd76535
Run: https://oz.warp.dev/runs/019f02ba-77d2-764f-99c4-caf605380dd3

This PR was generated with Oz.

…tion

- src/pages/api.astro: demote the server-rendered endpoint-index spec
  title from <h1> to <h2> (and per-endpoint headings <h2> to <h3>) so
  the page has a single H1 ("Warp & Oz HTTP API reference"), fixing the
  multiple_h1 SEO warning while keeping a clean h1 > h2 > h3 outline.
- src/content/docs/terminal/warpify/ssh.mdx: trim the meta description
  from 162 to 159 chars ("to get a" -> "for a") so it is no longer
  truncated in search results.

Co-Authored-By: Oz <oz-agent@warp.dev>
@petradonka petradonka added the seo SEO improvements label Jun 26, 2026
@cla-bot cla-bot Bot added the cla-signed label Jun 26, 2026
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 26, 2026 7:10am

Request Review

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

Labels

cla-signed seo SEO improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant