3679b7e739 Release docs for paperclip v2026.1005.0 (#147)
## Summary

Release docs for Paperclip **v2026.1005.0** (parent tag commit
`467125fa`).
- **Window:** `v2026.1001.0` → `v2026.1005.0`, 179 commits, 1,645 files,
compare truncation 0.
- **Branch:** cut from `nightly` (`c42305a`). Nightly had drafted
against parent master up to `a6306ba6`, which is 159 commits past the
tag.
- **Review:** every changed page was checked by hand against a checkout
of the tag.

**Headline doc changes:**
- **New pages:**
  - [Browser Use Cloud](docs/connectors/browser-use-cloud.md)
- [Memory connectors](docs/connectors/memory-connectors.md), plus
Cognee, Honcho, Supermemory and Zep
  - [Agent Chat](docs/experimental/agent-chat.md)
  - [Paperclip Runner](docs/reference/adapters/paperclip-runner.md)
- **Breaking changes applied:**
- @-mentions no longer start a run (#14577). Ten pages that still said
they did are fixed.
- Keyboard shortcuts are always on, and `/api/auth/preferences` is gone.
  - Connector setup is one screen (#14811).
- Agent files that persist across tasks, a GitHub skill **Sources** tab,
aggregators on by default, two-way Slack, Grok Build on the Runner,
refreshed model catalogs, and the new env vars, including
`PAPERCLIP_RUNNER_API_TOOLS_ENABLED` / `_COMPANY_IDS`.
- A changelog entry, and 113 pages stamped `paperclip_version:
v2026.1005.0`.

### ⚠ Post-tag leaks removed

These document parent `master` features that are **not in
v2026.1005.0**. They stay on `nightly` for the next release.

- **Pages removed entirely (9):**
  - `connectors/ai-usage.md` (7d59de61)
  - `connectors/custom-model-providers.md` (9f7057e1)
  - `connectors/connection-instructions.md` (4857799a)
  - `administration/agent-commentary.md` (b508a05c)
- `experimental/assistant-connections.md`,
`reference/api/assistant-mcp.md` and `reference/cli/mcp.md` (e34abee6,
22a3ea34, 2d0c1381)
  - `guides/org/agent-identity.md` (a590ab76)
  - `reference/cli/runtime.md` (a6306ba6)
- **Reverted to `main`:**
  - `agentmail.md` (6c1a75da)
  - `openrouter.md`; only the released access-line change was re-applied
- `asana.md` (4ac37410); only the released access-line change was
re-applied
  - `delegation.md` and `team-catalog.md` (862a5758, b17019e1)
  - `adapters/overview.md` (a6306ba6)
  - `api/tool-gateway.md`, the GET → 405 change
- **Sections trimmed (~50 pages):**
  - AgentMail as a default connection
  - **Check usage**
  - aggregator account sync and grouping (b43073d1)
  - MCP `offline_access` (839cac13) and readable test results (6d654f63)
  - saved connection guidance
- the **Update skill** tool (eb049aeb) and managed-checkout import roots
(427e0484)
  - low-trust scoped work and owner-chat edits (0829d94a, 4039d4f0)
  - reduced default instructions (b17019e1)
  - Chat leading the nav and the combined inbox (1c07b590)
  - steer/interrupt recovery (cc67d4e1)
  - branch artifacts without a remote (db72ad4c)
  - Cursor on the Runner (a6306ba6)
  - Claude/Codex model ordering (92ad158c, d9b64ee2)
  - Daytona stalled-log polling (4e524632)
  - the agent identity env vars
  - the shared task composer for new tasks (2c43b391)

### ⚠ Drift

Checked against the tag. **No real drift remains:**
- **Env vars that exist at the tag but are read through helpers the
checker doesn't scan (false positives):**
  - `PAPERCLIP_WORKSPACE_GIT_SCAN_*`
  - `PAPERCLIP_WORKSPACE_GIT_SNAPSHOT_TIMEOUT_MS`
  - `PAPERCLIP_RUNNER_API_COMPANY_CAPTURE_MAX_BYTES`
  - `PAPERCLIP_CLOUD_CONNECTOR_*`
- `PAPERCLIP_ID_CONNECTOR_*` are documented as **retired**, which is
correct.
- Verify: `/api/companies/{companyId}/chats/{agentRef}` is registered
dynamically (`router[method]`, `issues.ts:17185`). False positive.
- Verify: `/api/agent-avatars/...png` and
`/api/companies/import/transfers*` are known false positives from
constant or param registration.

### ⚠ Verification Failures / review notes

- **Asana:** `asana.md` keeps "register your own Asana OAuth app". The
tag's `asana.json` advertises "Sign in with Asana" (DCR), but Asana's v2
MCP server needs a registered app, and sign-in only works after post-tag
#14756. Confirm you're happy with that wording.
- **Google Docs/Sheets/Slides/Calendar:** the "Reconnect after the scope
change" paragraph isn't confirmed in code.
- **`grok-local.md`:** "Intel Mac rejected" and "subscription sign-in,
no automatic fallback" are only partly confirmed.
- **`paperclip-runner.md`:** "Grok cannot automatically approve
Paperclip tool calls under narrower ACP modes" isn't confirmed directly.
- **`cognee.md`:** the tag's setup text says `uv` is required, which
contradicts `tool-access.ts:3560`. The page follows the code.
- **`work-modes.md`:** the per-reply mode chip was removed because it
couldn't be found at the tag.
- **`browser-use-cloud.md`:** the `frame-src` CSP advice is general
advice, not code-backed.

### Screenshots

**180 of 350 screenshots are stale**, across 41 routes (see
`SCREENSHOTS_PENDING.md`). None were recaptured in this PR; refresh
separately with `npm run screenshots:refresh`.

### Other open PRs

- **#143** (Browser Use Cloud + Neon, targets `main`): Browser Use Cloud
is covered here, and Neon is post-tag (5b8b2b38). Suggest closing it or
retargeting it to `nightly`.

## Checks

- `docs:build` passes.
- `sync:check` passes, with no broken internal links.
- `docs:test` passes in full: SEO metadata, crawlable links (275
routes), doc link resolution (2,198 checks), static routes, asset
fingerprints, skills nav, and skill source blocks.

## After merge (Phase 9)

- [ ] `docs/v2026.1005.0` tag is created by the workflow (keep the PR
title as is).
- [ ] `node scripts/sync/realign-nightly.mjs release/v2026.1005.0
--push`. The nine removed pages stay on `nightly`.
- [ ] Flip `nightly`'s `.sync-state.json` back to `branch_mode:
nightly`.
- [ ] docs.paperclip.ing serves the release: the changelog's top entry
reads v2026.1005.0, and `/connectors/browser-use-cloud/` returns 200.

🤖 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]>
2026-10-07 09:19:28 +02:00
2026-04-30 11:04:18 -05:00

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 — paperclip command 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 main deploy production at https://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.

S
Description
Paperclip documentation
Readme CC-BY-4.0
491 MiB
0 Stars 1 Watchers 0 Forks
Languages
JavaScript 91.1%
CSS 7.1%
HTML 1.6%
Shell 0.2%