mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-09 17:41:56 -10:00
## 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]>
124 lines
3.5 KiB
Markdown
124 lines
3.5 KiB
Markdown
---
|
|
seo_title: Database Configuration
|
|
seo_description: Paperclip runs PostgreSQL through Drizzle ORM. One schema across every supported mode — what differs is where Postgres runs and how it is reached.
|
|
---
|
|
|
|
# Database
|
|
|
|
Paperclip uses PostgreSQL through Drizzle ORM. The same schema works across the supported database modes; the difference is where PostgreSQL is running and how Paperclip connects to it.
|
|
|
|
Use this page when you are choosing between embedded, local Docker, or hosted PostgreSQL.
|
|
|
|
---
|
|
|
|
## Database Modes
|
|
|
|
| Mode | Best for | Setup cost |
|
|
|---|---|---|
|
|
| Embedded PostgreSQL | Local development, one-command installs | Zero config |
|
|
| Local PostgreSQL in Docker | A local prod-like database | Low |
|
|
| Hosted PostgreSQL | Production and shared deployments | Higher |
|
|
|
|
> **Note:** The app logic does not change across modes. Only `DATABASE_URL` and the storage location change.
|
|
|
|
---
|
|
|
|
## Embedded PostgreSQL
|
|
|
|
This is the default mode when `DATABASE_URL` is not set.
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
On first start, Paperclip:
|
|
|
|
1. creates `~/.paperclip/instances/default/db/`
|
|
2. ensures the `paperclip` database exists
|
|
3. runs migrations for an empty database
|
|
4. starts serving requests
|
|
|
|
Data persists across restarts in that directory.
|
|
|
|
Use this mode when you want the simplest possible local setup.
|
|
|
|
Reset the local database by deleting the data directory:
|
|
|
|
```sh
|
|
rm -rf ~/.paperclip/instances/default/db
|
|
```
|
|
|
|
The Docker quickstart uses embedded PostgreSQL by default too. See [Docker](./docker.md) for the container setup.
|
|
|
|
---
|
|
|
|
## Local PostgreSQL In Docker
|
|
|
|
Use this if you want a standard PostgreSQL server locally instead of the embedded runtime.
|
|
|
|
Start the database:
|
|
|
|
```sh
|
|
docker compose up -d
|
|
```
|
|
|
|
This starts PostgreSQL 17 on `localhost:5432`.
|
|
|
|
Set the connection string in your environment:
|
|
|
|
```sh
|
|
cp .env.example .env
|
|
# DATABASE_URL=postgres://paperclip:paperclip@localhost:5432/paperclip
|
|
```
|
|
|
|
Then push the schema:
|
|
|
|
```sh
|
|
DATABASE_URL=postgres://paperclip:paperclip@localhost:5432/paperclip \
|
|
npx drizzle-kit push
|
|
```
|
|
|
|
Use this mode when you want to mirror a normal PostgreSQL deployment more closely while still staying local.
|
|
|
|
---
|
|
|
|
## Hosted PostgreSQL
|
|
|
|
For production, use a hosted PostgreSQL provider such as [Supabase](https://supabase.com/).
|
|
|
|
Typical setup:
|
|
|
|
1. create a project at [database.new](https://database.new)
|
|
2. copy the connection string from the database settings
|
|
3. set `DATABASE_URL` in your deployment environment
|
|
|
|
Supabase exposes two useful connection styles:
|
|
|
|
- direct connection on port `5432` for migrations and one-off scripts
|
|
- pooled connection on port `6543` for the running application
|
|
|
|
If you use the pooled connection, disable prepared statements in `packages/db/src/client.ts`:
|
|
|
|
```ts
|
|
export function createDb(url: string) {
|
|
const sql = postgres(url, { prepare: false });
|
|
return drizzlePg(sql, { schema });
|
|
}
|
|
```
|
|
|
|
> **Warning:** Use the direct connection for schema changes. Pointing migrations at the pooled endpoint is a common way to get avoidable connection errors.
|
|
|
|
---
|
|
|
|
## Switching Modes
|
|
|
|
| `DATABASE_URL` | Result |
|
|
|---|---|
|
|
| Not set | Embedded PostgreSQL |
|
|
| `postgres://...localhost...` | Local Docker PostgreSQL |
|
|
| `postgres://...supabase.com...` | Hosted PostgreSQL |
|
|
|
|
The Drizzle schema under `packages/db/src/schema/` stays the same in every case.
|
|
|
|
> **Tip:** If your deployment feels healthy but the data keeps disappearing, check whether you are still on embedded PostgreSQL. That mode is intentionally local and persistent only inside the instance directory.
|