Aron PrinsandClaude Opus 5.5
dc84da0476
The released docs were missing five connection-pool environment variables that ship in paperclip `v2026.1023.0`, and the Hosted PostgreSQL section told readers to edit `packages/db/src/client.ts` to disable prepared statements, though `DATABASE_PREPARED_STATEMENTS=false` already does that. - `deploy/database.md`: replaces the code-edit snippet with the env var; adds a **Connection Pool Settings** section (defaults, startup validation, `pg_stat_activity` lookup, `max_connections` sizing, shutdown behaviour). - `deploy/environment-variables.md`: rows for `DATABASE_PREPARED_STATEMENTS` and the five pool variables. Checked line by line against `packages/db/src/client.ts` and `server/src/index.ts` at the `v2026.1023.0` tag. Two things that exist only on parent master are deliberately left out and stay in nightly (#159): the `paperclip-controller-lease` liveness pool and the `DATABASE_PREPARED_STATEMENTS=true` mode that also prepares ORM queries. `docs:build` and `sync:lint-links` pass. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <[email protected]>
Paperclip Docs
Source for the Paperclip documentation site — user guides, API and CLI reference, adapter docs, and deployment notes.
Read the docs: https://docs.paperclip.ing/
What's inside
- Guides — Getting started, core concepts, and day-to-day usage.
- API reference — Control-plane endpoints and payload schemas.
- CLI reference —
paperclipcommand surface. - Adapters — Plugin authoring and the integrations catalogue.
- Deploy — Self-hosting, upgrades, and operational guidance.
The site is a single static shell that renders the Markdown files in docs/ directly — no framework, no build step required to read the raw pages.
Build and deployment
Build a release bundle locally with:
npm run docs:build
Cloudflare Pages is connected directly to paperclipai/paperclip-docs through GitHub. There is no normal Wrangler publish step for this repo:
- Pushes to
maindeploy production athttps://docs.paperclip.ing/. - Pushes to other branches create Cloudflare Pages preview/canary deployments.
- Canary URLs are created by Cloudflare for each deployment, for example
https://92b9a99c.paperclip-docs-74t.pages.dev. Use the URL shown in the Cloudflare Pages deployment row or GitHub deployment/check for the pushed branch and commit.
That auto-deploy is not guaranteed — it has silently failed to fire on a push to main before. After anything reader-facing lands, check the live site rather than the merge, and republish by hand if it's stale:
npm run docs:build
npx wrangler pages deploy .site --project-name paperclip-docs --branch main
Contributing
Spotted a typo, a broken link, or something that could be clearer? There are two easy paths, both linked from the footer of every docs page:
- Suggest an edit — opens the underlying Markdown file in GitHub's web editor. Make the change and submit a PR without leaving the browser.
- Report an issue — opens a prefilled Docs feedback issue with the page URL already attached.
For larger changes, fork the repo and open a PR against main. Screenshots live under docs/user-guides/screenshots/{light,dark}/ and should be provided in both themes when replacing UI captures.
Community
License
Copyright (c) 2026 Paperclip Community.
The Paperclip software is open source — see the main paperclip repository for its license.
The documentation in this repository is licensed under Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0). You may read and share it for non-commercial purposes with attribution. Commercial use of any kind requires prior written permission from the copyright holders. See LICENSE for the full text.
Unlisted hosted beta guide
docs/hosted-beta.md is built at /hosted-beta/ by site/build-release.mjs.
It reuses the full docs shell and initializes page tools without adding the page to the navigation/search manifest.
Keep it out of site/content.json: it is deliberately absent from navigation,
search, homepage listings, previous/next links, and the sitemap. It has a
noindex meta tag; this is a public page, not an access-controlled document.
Run node scripts/verify-unlisted-beta.mjs to verify root/subpath builds and
exclusion from discovery. Preview with npm run docs:build and npm run docs:serve.