Automated SEO fixes: resolve multiple H1 on /api and trim SSH meta description#258
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR makes two narrowly scoped SEO fixes: it trims the SSH page meta description and demotes the hidden API endpoint index headings so /api keeps a single page-level H1. I reviewed the annotated diff, PR description, and spec context; no approved spec context was provided.
Concerns
- No blocking correctness, documentation-quality, spec drift, or security concerns found in the changed lines.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
2 participants
Summary
Ran the
docs-seo-auditskill against the livedocs.warp.devsitemap (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<h1>to<h2>, and the per-endpoint headings from<h2>to<h3>./apipage now has a single<h1>(Warp & Oz HTTP API reference), resolving themultiple_h1warning while preserving a cleanh1 > h2 > h3outline. This is a semantic-only change to a visually-hidden, crawler-facing section.src/content/docs/terminal/warpify/ssh.mdxto get a→for a) so it is no longer truncated in search results. Wording and keywords are unchanged otherwise.Not changed (intentional)
title_too_shortwarnings 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 siblingCloud agents overviewpage. Per the skill's caution against over-eager prefixing, it was left as-is.Validation
/apipage now has exactly one<h1>and balancedh1 > h2 > h3heading tags.npm run buildwas 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.