mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
2535f6c99c
## Summary Release docs for Paperclip **v2026.1012.0** (parent tag commit `bba6a45f`). - **Window:** `v2026.1005.0` → `v2026.1012.0`. That is 132 commits and 1,242 files, with no compare truncation. - **Branch:** cut from `nightly` (`fe556e1`). Nightly had drafted against parent master up to `abbd8800`. The release was cut from master at `22a3ea3` (Oct 6), so nightly's last 39 commits are post-tag. - **Review:** every changed page was checked by hand against a checkout of the tag. The tag-accuracy gate was then re-run on the result. **Headline doc changes:** - **New pages:** - [Assistant connections (MCP)](docs/experimental/assistant-connections.md), with the [Assistant MCP API](docs/reference/api/assistant-mcp.md) and [`paperclipai mcp`](docs/reference/cli/mcp.md) references - [Saved connection instructions](docs/connectors/connection-instructions.md) - [Check AI account usage](docs/connectors/ai-usage.md) - [Task-pinned AI routing](docs/experimental/task-pinned-ai-routing.md) - [Neon](docs/connectors/neon.md) - **Breaking changes documented:** - Restore locks moved to SQLite (#14869). [Update Paperclip](docs/how-to/update-paperclip.md) now has a "stop everything first" upgrade and rollback flow. - Stored tool grants are enforced as written (#14915). This is covered in the [Tool Gateway API](docs/reference/api/tool-gateway.md) and the [Access model](docs/connectors/access-model.md). - **Other release coverage:** - The connection-instructions contract for HTTP and process adapters (`connectionInstructions`, `PAPERCLIP_CONNECTION_INSTRUCTIONS_FILE`). - Much shorter default instructions, and default config grants for new agents. - The `update_skill` tool. - Aggregator accounts gathered into one catalog. - Chat-first navigation and the combined inbox. - The rebuilt New task dialog. - "Model at capacity" and "Model unavailable". - Sonnet 5.5, GPT-6.1 Sol and new harness pins. - The supported remote Codex range, and Codex resuming after a server restart. - Watchdog thresholds of 5 and 15 minutes. - `tool_discovery_busy`. - The Docker provider pack. - A changelog entry, and 75 pages stamped `paperclip_version: v2026.1012.0`. ### ⚠ Post-tag leaks removed These document parent `master` features that are **not in v2026.1012.0**. They stay on `nightly` for the next release. - **Pages removed (7):** - `administration/agent-commentary.md` (b508a05c) - `guides/org/agent-identity.md` (a590ab76) - `reference/cli/runtime.md` (a6306ba6) - `connectors/custom-model-providers.md` (9f7057e1) - `connectors/enterpret.md` (88ff98b8) - `connectors/superagent.md` (8cbd21b3) - `connectors/telem.md` (f77fcbf4) Their nav entries and catalog rows are already removed, and no page links to them. - **Reverted to `main`:** - `roles-and-permissions.md`, `administration/company.md` and `add-a-human-teammate.md`. Operator's 14 default keys come from 582911ba. - The costs guide and `api/costs.md`. Durable accounting, by-user costs and per-account quota come from 799e4d55, eab93fd4 and 892b0b36. - `adapters/cursor-local.md` (a6306ba6) - `deploy/database.md` and `deploy/environment-variables.md`, which carried agent identity and complaints. - `browser-use-cloud.md` - `back-up-and-restore-a-company.md` - **Sections trimmed:** - The assistant MCP pages now match the tag: `paperclip:read`/`paperclip:write`/`offline_access` only, 10 direct tools, and no file transfer (2d0c1381, 99a9de99). - Server-host sign-in for Anthropic, OpenAI and xAI is back to the terminal-command flow (e38d6d16, 2ca0d26a). - OpenRouter is OpenCode-only again (9f7057e1). - Requested vs granted OAuth scopes are removed (ea8e6861). - PR review waits are removed (228f0e28). - Historical-question reminders and "No project" in the composer are removed (faa8e452, ee3c728b). - Plugin lifecycle hooks are removed (1cebdd4c). - Cursor on the Runner is removed (a6306ba6). - The aggregator "Waiting for sign-in" status is removed. - Source links pinned to post-tag commits now point at the tag commit. ### ⚠ Drift Checked against the tag: - **High:** the `operator` default grants were **real** drift. Fixed by reverting the post-tag tables. - **High:** the agent-identity paths and env vars were real at nightly but are post-tag. They're removed (see above). - **High:** `PAPERCLIP_WORKSPACE_GIT_SCAN_*`, `PAPERCLIP_WORKSPACE_GIT_SNAPSHOT_TIMEOUT_MS`, `PAPERCLIP_RUNNER_API_*` and `PAPERCLIP_CLOUD_CONNECTOR_*` are known false positives. They are read through helpers the checker doesn't scan. - **High:** `PAPERCLIP_ID_CONNECTOR_*` is documented as retired, which is intentional. - Verify: the `/accounting/*`, `costs/by-user` and `agents/{id}/identity` routes are no longer documented, because they're post-tag. - Verify: `agent-avatars`, `companies/import/transfers*` and `chats/{agentRef}` are known param/constant-registration false positives. ### ⚠ Verification Failures / review notes - **`reference/cli/mcp.md`:** the gate flags `--device` and `--url`. This is a false positive: both are `requiredOption`s in `cli/src/commands/mcp.ts` at the tag. - **New pages the gate can't auto-confirm:** each was verified by hand at the tag. They are assistant-connections, task-pinned-ai-routing, ai-usage and connection-instructions. - **`neon.md`:** says "open **Connectors**", following the Supabase guide. The parent's notes call the screen "Apps → Browse". - **`connection-intents.md`:** the AgentMail card details ("shares the key with every person in the company", "resumes after reload") are only partly confirmed. - **`task-chat.md`:** the queued-message details came from an earlier nightly and couldn't be traced to a specific commit. - **Upstream inconsistency:** the Codex adapter's in-code doc string (`codex-local/src/index.ts:181`) contradicts the code about the bypass flag. Our docs follow the code. ### Screenshots **126 of 350 screenshots are stale** across 26 routes (see `SCREENSHOTS_PENDING.md`). None were recaptured in this PR. ### Other open PRs - **#143** (Browser Use Cloud + Neon, targets `main`): both are now covered here. Suggest closing it. - **#140** (Enterpret, targets `main`): Enterpret is post-tag (88ff98b8). Suggest retargeting it to `nightly` or closing it. ## Checks - [x] `npm run docs:build` - [x] `npm run docs:test` (all suites) - [x] `sync:lint-links` and `sync:verify-nav`. The only orphans are the 7 pages above plus 4 intentional ones. - [x] `check-tag-accuracy` re-run. The only remaining flags are the ones explained above. - [x] Removed the 7 post-tag pages listed above (`cbece5b`), plus fixes from a second, independent verification pass - [ ] After the squash-merge, run `node scripts/sync/realign-nightly.mjs release/v2026.1012.0 --push`, then flip `nightly`'s `.sync-state.json` back to `branch_mode: nightly`. - [ ] Confirm the `docs/v2026.1012.0` tag and that docs.paperclip.ing serves the new changelog entry. 🤖 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.