Commit Graph
4 Commits
Author SHA1 Message Date
Aron PrinsandClaude Opus 5 325c9eb819 seo: hand-write titles and descriptions for all 192 pages (#115)
## 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]>
2026-08-25 22:51:42 +02:00
Aron PrinsandClaude Opus 4.7 bd1799fc8d Release docs for paperclip v2026.517.0
- New adapter page: Grok Local (`grok_local`), wired into the Adapters
  overview table and nav.
- Issues guide: document locking workflow (lock/unlock, derived-document
  redirect for agents) and the new Board-view scaling controls (density,
  cold-lane mode, column page size). Documents are now live-refreshed.
- Issues API reference: lock / unlock endpoints, plus the
  `redirectedFromLockedDocument` response for agent writes into locked
  documents.
- Sandbox Providers (Cloudflare): reliability tuning notes — larger
  instance type, SSE keepalives, UTF-8-safe stdout, sandbox-aware probe
  budgets, corrected Pi install path.
- LLM Wiki plugin: bundled bootstrap assets and namespace-safe spaces
  migration validation.
- SCREENSHOTS_PENDING.md regenerated for v2026.517.0.
- .sync-state.json bumped to v2026.517.0.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
2026-05-18 11:24:58 +02:00
Aron PrinsandClaude Opus 4.7 8ef7494782 docs: hoist LLM Wiki install command; clarify bundled-examples vs catalogue
Address operator confusion observed in support channels: users on
non-Docker / systemd installs report not being able to install the
LLM Wiki plugin. Root cause is documentation, not code — the plugin
is published to npm and installs cleanly via the standard CLI, but:

- Our reference page buried the npm package name in the "developing
  from a checkout" subsection. Operators scanning for the install
  command had to read past the dev section to find @paperclipai/...
  Now the Quick install section is the first actionable thing on
  the page, with the explicit `paperclipai plugin install` line.

- `paperclipai plugin examples` (and the dashboard's Available
  Plugins list) only returns the four reference example plugins
  from BUNDLED_PLUGIN_EXAMPLES in server/src/routes/plugins.ts. It
  is NOT the full first-party catalogue. Operators who looked there
  for LLM Wiki concluded it wasn't shipped. Added a callout to
  docs/administration/plugins.md to make this explicit and link out
  to the LLM Wiki reference page for plugins installed by full npm
  name.

Co-Authored-By: Claude Opus 4.7 <[email protected]>
2026-05-14 11:03:36 +02:00
Aron PrinsandClaude Opus 4.7 500e8d4f97 docs: fill plugin coverage gaps surfaced during v2026.513.0 sync
Three first-party plugins were missing from the docs because they
shipped before /sync-docs started tracking the repo (or were missed
in a prior batched catchup):

- NEW docs/reference/plugins/llm-wiki.md — full reference page for
  the LLM Wiki plugin (introduced in v2026.512.0, PR #5716). Covers
  what the plugin contributes to the dashboard, its managed agent
  and skills, REST routes, and operator tips.
- docs/administration/plugins.md — adds the missing
  plugin-orchestration-smoke-example bullet to the first-party
  examples list (sibling to the four already listed).
- docs/reference/adapters/sandbox-providers.md — adds a Fake Sandbox
  (provider: "fake-plugin") section for the private
  @paperclipai/plugin-fake-sandbox package, intended for testing and
  reproducing plugin-runtime issues without external infrastructure.
- site/content.json — nav entry for the new LLM Wiki page under
  Reference / Plugins.

Co-Authored-By: Claude Opus 4.7 <[email protected]>
2026-05-14 10:48:14 +02:00