mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
Aron PrinsandClaude Opus 5
325c9eb819
## Why
The build derived `<title>` from the **sidebar label** and the
description from the **first paragraph clipped to 220 characters**. Both
are the wrong source. A sidebar label is written for a 240px-wide nav
that supplies its own context; a search result has none.
On production that produced:
- **7 pages titled "Overview"**, and 32 pages sharing a title with
another page
- **109 of 193 descriptions cut off mid-word**, and 174 over 160
characters (where Google truncates)
```
/guides/welcome/key-concepts/
BEFORE (220): ...and if you misunderstand them early, the product wi
```
Near-identical titles are the weak-differentiation signal behind
"crawled — currently not indexed", which is the exact symptom on this
property.
## What changed
`seo_title` and `seo_description` frontmatter on **every one of the 192
pages**, written by hand against each page's real content and optimised
for the click — lead with what the reader can do, name the concrete
things covered, no keyword stuffing, no repeating the title.
| | Before | After |
|---|---|---|
| Duplicate titles | 32 pages | **0** |
| Duplicate descriptions | — | **0** |
| Descriptions cut mid-word | 109 | **0** |
| Descriptions over 160 chars | 174 | **0** |
| Title length (incl. suffix) | up to "Overview" | **26–60** |
| Description length | 31–240 | **122–158** |
**No prose was rewritten.** I measured content overlap between the
colliding pairs first — only 17–23%, so these were always distinct pages
wearing the same label, not duplicate content. The `docs/` diff is **564
insertions, zero deletions**.
### Examples
```
BEFORE — all seven identical: "Overview | Paperclip Docs"
AFTER: "Adapters Overview" "API Overview" "CLI Overview"
"Deployment Overview" "Bundled Skills" "Optional Skills"
"Experimental Features"
BEFORE — both identical: "Issues | Paperclip Docs"
AFTER: "Issues: Creating and Tracking Work" /guides/day-to-day/issues/
"Issues API" /reference/api/issues/
```
```
/guides/getting-started/five-minute-path/
BEFORE (220): The shortest route from a running Paperclip instance to an agent that has
just completed work for you. After Paperclip is installed, the path takes
about 5 minutes: create a company, hire a CEO agent, approve its first s
AFTER (131): Install Paperclip, create a company, hire a CEO agent, and approve its
first strategy — a working AI company in about five minutes.
```
## Plumbing
- **`site/build-release.mjs`** prefers the authored fields; the derived
path stays only as a fallback the CI gate prevents ever reaching.
`<title>`, `<meta name="description">`, and the `TechArticle` JSON-LD
all read from the same source.
- **`site/app.js`** uses the same fields, so a client-side transition
cannot leave a different title on screen than the crawler was served.
Verified in-browser: navigating `/guides/day-to-day/issues/` →
`/reference/api/issues/` swaps to exactly the server-rendered values, no
JS errors.
- **`scripts/verify-seo-metadata.mjs`** (new) enforces presence,
uniqueness, length, complete-sentence endings, and the
frontmatter-safety rules. Wired into `docs:test` and CI as its own step.
I negative-tested the gate rather than assuming it works — it correctly
fails on a duplicate title, a mid-word description, and a missing field,
and passes again once restored.
## Automating it going forward
`skills/sync-docs/SKILL.md` now:
- gains an **"Authored SEO metadata"** section: why the fields exist,
the enforced rules as a table, and how to actually write them (title
names the subject not the nav position; description writes for the
click; never generate mechanically from the first paragraph — *that is
the fallback the gate exists to prevent*).
- requires both fields in the **page-authoring instruction** given to
every subagent, with guidance on when to update an existing description
versus leave it.
- runs `docs:test:seo-metadata` and `docs:test:crawlable-links` as
**fail-loud gates in Phase 7** before commit.
- documents all six build gates in the files/gates section.
So once this lands, a new page cannot ship without hand-written
metadata, and a title collision cannot reach production.
## Verified
All six verifiers pass:
```
Static route verification passed
Asset fingerprint verification passed
Hierarchical Skills nav verification passed
Skill source block verification passed (11 skill pages, 1 control page)
Crawlable-link contract passed: 40886 internal links across 194 pages resolve in one hop
Authored-SEO contract passed: 192 pages carry a unique, hand-written seo_title and seo_description
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
42 lines
2.4 KiB
JSON
42 lines
2.4 KiB
JSON
{
|
|
"name": "paperclip-docs",
|
|
"private": true,
|
|
"type": "module",
|
|
"scripts": {
|
|
"docs:build": "node site/build-release.mjs --base-path / --out-dir .site",
|
|
"docs:build:github-subpath": "node site/build-release.mjs --base-path /paperclip-docs/ --out-dir .site",
|
|
"docs:build:auto": "node site/build-release.mjs --base-path auto --out-dir .site",
|
|
"docs:test:static-routes": "node scripts/verify-static-routes.mjs",
|
|
"docs:test:asset-fingerprints": "node scripts/verify-asset-fingerprints.mjs",
|
|
"docs:test:hierarchical-skills-nav": "node scripts/verify-hierarchical-skills-nav.mjs",
|
|
"docs:test:skill-source-blocks": "node scripts/verify-skill-source-blocks.mjs",
|
|
"docs:test:crawlable-links": "node scripts/verify-crawlable-links.mjs",
|
|
"docs:test:seo-metadata": "node scripts/verify-seo-metadata.mjs",
|
|
"docs:test": "npm run docs:test:static-routes && npm run docs:test:asset-fingerprints && npm run docs:test:hierarchical-skills-nav && npm run docs:test:skill-source-blocks && npm run docs:test:crawlable-links && npm run docs:test:seo-metadata",
|
|
"docs:serve": "python3 -m http.server 4321 --directory .site",
|
|
"sync:lint-links": "node scripts/sync/lint-links.mjs",
|
|
"sync:verify-nav": "node scripts/sync/verify-nav.mjs",
|
|
"sync:backfill-screenshots": "node scripts/sync/backfill-screenshots.mjs",
|
|
"sync:compare-window": "node scripts/sync/compare-window.mjs",
|
|
"sync:check-drift": "node scripts/sync/check-drift.mjs",
|
|
"sync:detect-renames": "node scripts/sync/detect-renames.mjs",
|
|
"sync:verify-edit": "node scripts/sync/verify-edit.mjs",
|
|
"sync:verify-screenshots": "node scripts/sync/verify-screenshots.mjs",
|
|
"sync:check": "npm run sync:lint-links && npm run sync:verify-nav && npm run sync:verify-screenshots && npm run sync:check-drift",
|
|
"sync:test": "node scripts/sync/test.mjs",
|
|
"screenshots:seed": "node scripts/screenshots/seed.mjs",
|
|
"screenshots:capture": "node scripts/screenshots/capture.mjs",
|
|
"screenshots:sync-registry": "node scripts/screenshots/sync-registry.mjs",
|
|
"screenshots:refresh": "node scripts/screenshots/run.mjs",
|
|
"screenshots:serve": "node scripts/screenshots/run.mjs --serve",
|
|
"screenshots:refresh:all": "node scripts/screenshots/run.mjs --all"
|
|
},
|
|
"devDependencies": {
|
|
"@playwright/test": "^1.58.2",
|
|
"esbuild": "^0.25.12"
|
|
},
|
|
"dependencies": {
|
|
"marked": "^12.0.2"
|
|
}
|
|
}
|