mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
0ea1994fa7
## Summary Release docs for Paperclip **v2026.1023.0** (parent tag commit `1b4c8038`). - **Window:** `v2026.1012.0` → `v2026.1023.0`. The tag was cut from parent `master` at 2026-10-12, so the cumulative window is the merge-base `22a3ea34` → `1b4c8038`. That's 200 commits and 2,501 files, with no compare truncation. - **Branch:** cut from `nightly` (`1b81e21`). Nightly had drafted against parent master up to `043f2514` (Oct 22), which is 496 commits past the tag. Most of nightly's #151–#155 work is post-tag. - **Review:** six reviewers checked all 161 changed pages hunk by hunk against a local checkout of the tag, using post-tag history (`1b4c8038..043f2514`) to date each claim. The tag-accuracy gate was then re-run on the result. **Headline doc changes:** - **New pages (21):** - [Custom model providers](docs/connectors/custom-model-providers.md) - [Decision Models API](docs/reference/api/decision-models.md) - [Cases](docs/experimental/cases.md) - [External agents: OpenAI Dot](docs/experimental/external-agents.md) - [Agent cryptographic identity](docs/guides/org/agent-identity.md) - [Agent complaints and suggestions](docs/administration/agent-commentary.md) - [Runtime Commands](docs/reference/cli/runtime.md) - 14 connector guides: Bitly, Calendly, Context7, Enterpret, Exa, Firecrawl, Gauge, GSC Wizard, Make, Parallel Search, Superagent, Tavily, Telem.AI and Windsor.ai - **Updated pages:** - Private tasks and projects, with sharing and inherited privacy. - Costs: estimated, unpriced and subscription spend, the Overview breakdowns, provider cost reports, and the Decisions view. - Operators get default company editing permissions (#15377). - Agent setup checks and your primary agent. - Slack: automatic setup and **Require at-mention**. - The simplified dedicated GitHub App setup. - Cursor and Pi on Paperclip Runner, and the **Harness** label. - Expanded assistant MCP tools and the `paperclip:configure` scope. - CSV and HTML artifact previews. - The plugin agent lifecycle contract. - Server-host AI sign-in, and new Linear, Airtable and Hugging Face methods. - A changelog entry, and 102 pages stamped `paperclip_version: v2026.1023.0`. ### ⚠ Post-tag leaks removed These document parent `master` features that are **not in v2026.1023.0**. They stay on `nightly` for a later release. - **Pages removed (7):** - `connectors/github-copilot.md` (92b23813) - `connectors/google-workspace.md` (23b2ceb0) - `connectors/braintrust.md` (92cfd701) - `connectors/daytona.md` (0b62c736) - `connectors/ditto.md` (a1e2173c) - `connectors/speko.md` (22d05644) - `connectors/prompt-injection-prevention.md` (2c96f767) Their nav entries and catalog rows are already removed, and no page links to them. - **Reverted to `main`:** - 54 pages whose nightly changes were all post-tag. That includes: - The Google per-app "no longer listed" notes and Gmail archive (23b2ceb0, e4ce9890). - The skills guide and the company-skill-policy API (repository packages and auto-updates: a9830414, 473c80d1, df4ee06e). - The Cases API (handoffs and workflows: 505e1a55, 0a5f1546). - The companies API (observability and prompt injection: ac9459ba, 2c96f767). - `deploy/docker.md`, the claude-code and hermes adapters, and `cli/agent.md` / `cli/service.md` (`--runner`, managed-shim guard). - The rest only changed Sources-link SHAs or had nightly-only wording. - **Sections trimmed:** - The Runner-default rollout, its upgrade notice and `runner` fields (adb69e8f, 8193abb9, 39e44a9d, 734c2653). - Grok Bot and Muse (b8ffeb97, e6dcc6b0). - Task workspaces and plugin project storage (f329b24e, 8b4ab65b). - Task Retry and recovery status lines (d33b40a5). - The commentary read API, `commentary:view`, and Pipelines removal (e6dcd1e8, e5927e1d, 90777488). - Scoped and async budget enforcement (30b753f6). - Plugin WebSocket routes, agent detail tabs, resource-lifecycle delivery and Runner tasks (42715d45, db65a086, 33cc567f). - Slack managed Cloud setup and DM at-mention changes (f0e12c85, df06df23). - Review-bot queued-comment, reconnect and naming changes (3b8324a2, 52459590, 7eea9d82). - OpenRouter attribution headers (9179d8dc). - Agent, project and routine search (7b9334cd). - Artifacts upload (762d680d). - Env-var rows: `NATIVE_HARNESS_BACKUP_*`, `WORKSPACE_COMPACTION_*`, `GIT_CACHE_*`/`GIT_BASE_*`, `SKILL_VERSION_RETENTION_*`, `NATIVE_MCP_*` and `SENTRY_RUN_FAILURES`. - `/api/liveness` (a0651c96). - Source links pinned to post-tag commits now point at the tag commit. ### ⚠ Drift Checked against the tag (`check-drift --against 1b4c8038`). There are 33 candidates, the same set as the last nightly runs: - **High:** `PAPERCLIP_WORKSPACE_GIT_SCAN_*`, `PAPERCLIP_WORKSPACE_GIT_SNAPSHOT_TIMEOUT_MS`, `PAPERCLIP_RUNNER_API_*`, `PAPERCLIP_MCP_AUTHORIZATION_ORIGIN` and `PAPERCLIP_CLOUD_CONNECTOR_*` are known false positives. They're read through helpers or `env.` receivers the checker doesn't scan. - **High:** `PAPERCLIP_ID_CONNECTOR_*` is documented as retired, which is intentional. - Verify: `agent-avatars` (`:file` param), `companies/import/transfers*` (constant route path), `chats/{agentRef}` (`router[method]` loop), and `mcp/requests/{id}` plus the Dot pairing routes (array registration in `public-mcp.ts`). These are known false positives. ### ⚠ Verification Failures / review notes - **Tag-accuracy gate false positives:** - `cli/runtime.md`: `--sha256` is a `.requiredOption` in `cli/src/commands/runtime.ts`. `SSL_CERT_FILE`, `SSL_CERT_DIR` and `NODE_EXTRA_CA_CERTS` are passed through by key list in `buildPiSetupEnvironment`. - `plugins/sdk.md`: `ENVIRONMENT_ACQUISITION_PROVIDER_STATES` is an SDK export. - `skills.md`: `PAPERCLIP_HELPER_STATE_DIR` is read in the skill's upload script. - `adapters/cursor-local.md`: the `acpx*` fields are validated in `paperclip-runner-permissions.ts`. - **New pages the gate can't auto-confirm:** each was confirmed by hand at the tag, against the app definitions, routes and UI. - **Claims kept on weaker evidence (commit message or UI string, not code) — please eyeball:** - "a new bot starts in mentions-only mode" (github-setup). - "Mentions work in issue and PR descriptions" (review-bot setup). - Airtable's "HTTPS or localhost" sign-in note. - The "37 tools" figure on assistant-connections. - Reservation semantics on the costs guide. ### Screenshots 142 of 278 screenshots depend on UI files changed in this window (see `SCREENSHOTS_PENDING.md`). They were last captured against v2026.1012.0 (#150), and a recapture is still pending. ### Checks `docs:build` and `sync:check` pass: no broken links, and the only orphans are the four pre-existing ones (`you-com`, `hosted-beta` and the two intentional CLI redirect pages). All eight `docs:test` suites pass. ### After merge 1. Confirm the `docs/v2026.1023.0` tag was created. 2. Run `node scripts/sync/realign-nightly.mjs release/v2026.1023.0 --push`. 3. Re-apply this branch's decisions on `nightly`. 4. Flip `nightly`'s state back to `branch_mode: nightly`. 5. Verify docs.paperclip.ing serves the changelog entry and new pages. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]> Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> Co-authored-by: Dotta <[email protected]> Co-authored-by: ClaudeCoder <[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.