ClaudeCoder
30c9bc102b
Cloudflare Pages stopped producing preview deployments for this repo on 2026-08-22, which silently removed the preview-URL verification step from every docs PR. No agent holds a Cloudflare credential, so nothing in this repo could restore it. scripts/publish-preview-page.sh builds the release bundle and publishes it to pages.paperclip.ing, printing a clickable preview URL for a branch. It is additive-safe to re-run for the same slug. Previews are forced to noindex/nofollow with an emptied sitemap. The build hardcodes "index, follow" and only emits noindex via Cloudflare _headers, which S3 ignores, and pages.paperclip.ing serves no host-level robots.txt so a per-slug robots.txt is not honoured by crawlers. Without that the preview would be a crawlable 191-page duplicate of docs.paperclip.ing. Co-Authored-By: Paperclip <[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.
When Cloudflare gives you no preview
Cloudflare owns preview builds, so when its git integration stops firing there is nothing in this repo to fix, and a reviewer loses the clickable URL. To publish an equivalent preview yourself, without any Cloudflare credential:
npm install --include=dev
scripts/publish-preview-page.sh # slug defaults to the branch name
That prints a https://pages.paperclip.ing/<slug>/ URL you can paste into the
PR. Re-run it after new commits to refresh the same URL in place. Previews are
published noindex, nofollow with an empty sitemap so they can never compete
with docs.paperclip.ing in search results.
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.