mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
main
281
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 Aron PrinsandClaude Opus 5.5
|
ee9de7fb26 |
Screenshots: recapture all for v2026.1106.0 (#174)
Recaptures every docs screenshot against `v2026.1106.0` (`d69631b0`). 196 of 278 were stale, and some contradicted the text, such as the removed **Run with provider trace** button and the old roster tabs. ## What changed - **Images:** 276 of 276 captured in both themes; 271 PNGs changed. Every registry entry is stamped `v2026.1106.0`. - **Pipeline:** `seed.mjs`, `capture.mjs`, `routes.mjs`, `config.mjs` and `github-review-fixture.mjs` now match this release's UI. No targets were dropped. - **Caption:** `experimental/file-viewer.md` now describes what its image shows. ## Check these - **Staged state:** the budget banner is removed in the browser on `dashboard/dashboard-overview`, `experimental/server-info` and `onboarding/sidebar-new-company-button`. The budget pages keep their real incidents. The seed also turns off hard stops outside the Budget Demo agents, and marks agents stuck in `verifying` as ready, so demo pages aren't paused. - **`experimental/file-viewer-browse`:** opening the task **Files** tab crashed the app at the tag on the seeded instance (`Maximum update depth exceeded` in `SidePanelTabs`), so the image shows a file open in its side panel instead. `file-viewer.md` still lists `g f` as an entry point. ## Review coverage All 140 light images were checked at contact-sheet size, so fine text wasn't readable that way. 44 images from the final run, 24 light and 20 dark, were opened at full size. The remaining dark images weren't viewed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <[email protected]> |
||
|
Aron PrinsandClaude Opus 5.5
|
c4608da865 |
Hotfix: Google tool names and project Environment note (v2026.1106.0) (#173)
Fixes two errors in the live docs for `v2026.1106.0`, both checked against the tag (`d69631b0`). - **Google tool names.** Calendar, Chat, Docs, Drive, People, Sheets, Slides and Workspace Search listed tools with dashes, such as `send-message`. The code and the **Permissions** tab use underscores (`packages/shared/src/google-workspace-connectors.ts`), which is what `gmail.md` and `google-workspace.md` already show. - **Project Environment dropdown.** `experimental/environments.md` said the dropdown saves the choice and the task's workspace card shows it. Neither is reliable: `parseProjectExecutionWorkspacePolicy` drops the value, and the card's project-default label is effectively unreachable. The note now only says the dropdown doesn't pick where runs go. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <[email protected]> |
||
|
|
d627632874 |
Release docs for paperclip v2026.1106.0 (#172)
Docs for parent release `v2026.1106.0` (`d69631b0`), up from `v2026.1023.0` (`1b4c8038`): 515 parent commits. ## How this branch was built The tag is 914 commits behind what `nightly` has drafted, so this branch isn't cut from `nightly` HEAD. It starts at nightly commit `1952052` (parent `043f2514`), 19 commits before the tag, then adds: - the `main` hotfix (#160) - the sync tooling from `nightly` - docs for those 19 commits Later nightly drafts stay on `nightly`, so no pages had to be removed. No `nightly-draft/*` PRs are open. ## What changed - **Runner by default:** new Claude, Codex, OpenCode and Pi agents start on Paperclip Runner on supported hosts, with **Legacy runner** and **Upgrade runner**. - **Workspaces:** cleanup of finished workspaces, optional Git expiration, and restore points for unsaved work. Restore points are off by default. - **New pages:** Prompt injection prevention, Google Workspace, GitHub Copilot, Speko, Braintrust, Daytona, Ditto and Unikraft. - **Breaking and upgrade notes:** the run history limit, Sentry run failures off by default and the DSN variables, the Docker start command for custom images, `--yes` on `instructions-file:delete`, and slower migrations on large instances. - **Also covered:** project repositories as skill sources, roster bulk edit, Artifacts V1 (experimental, off by default), composer dismissal, `expectedStatusVersion`, `unexecuted_review_stage`, and plugin workspace providers. - **Changelog:** a v2026.1106.0 entry in `reference/changelog.md`. ## Older text corrected These were wrong at the tag, and most are also wrong on the live site: - which permissions let an agent read a peer's configuration or change instructions (`api/agents.md`) - `decideNowCount`, which doesn't exist; the field is `deskBadgeCount` - `file-resources` routes, which are board-only - the **Create project** dialog fields, a CEO rule the code doesn't enforce, and where a terminated agent's reports appear - `instructions-file:put` and `:delete` examples that always failed (`cli/agent.md`) - a curl example that returned `422` (`api/cases.md`) - Google Workspace **Reconnect** instructions, which claimed it reopens the service picker - the `permissionKey` table, which listed 8 of 21 keys - drafting text at the end of `api/agents.md` ## ⚠ Please check these - **Product behaviour that may be a parent bug.** The docs now describe the tag's code, which you may prefer to fix upstream: - The project **Environment** dropdown saves a choice, but runs ignore it (`experimental/environments.md`). - `environments:manage` is granted by roles but no environment route checks it. - `suggest-changes` is documented as agent-only, because only agents have a consent path. Company skill policy decides skill edits. - **Reader-visible mismatches in the parent UI.** The docs follow the code. Upstream copy still mentions a "Built-in agents tab", says Copilot "awaits qualification", and tells people to "Reconnect Google Workspace to change access". ## ⚠ Post-tag leaks removed Nothing to remove from an already-drafted page: post-tag surfaces such as 1Password, Vercel, Supabase deploy, custom gateway onboarding and Artifacts V1 as default never came onto this branch. Authors left out post-tag hunks of the next nightly draft, and the reasons are in the run notes. ## ⚠ Drift None. Zero findings at the tag, from a full parent snapshot. ## ⚠ Verification Failures The tag-accuracy gate reports one leak and nine review entries. None is a real failure: - **Leak:** `reference/cli/service.md`, `paperclipai payload and`. This is a false positive; it's prose from a real message at `cli/src/commands/service.ts:184`. - **Review, 8 new connector pages:** the gate can't confirm new pages. Reviewers confirmed each surface exists at the tag. - **Review, `local_tools`:** an example value from the tag's Runner README. Not provable from code, and kept deliberately: - `sandbox-providers.md` uses `sandbox.yaml`. The tag's README says `install.yaml`, which returned 404 when checked. The upstream fix is post-tag. - The Google Workspace row about older OAuth brokers rests on release notes and a design doc. The broker isn't in this repo. - External claims about provider behaviour (for example Braintrust, Daytona, Unikraft and Google scopes). ## ↻ Renames detected None. The rename helper wasn't run: the 19-commit delta adds no new adapter, skill, or plugin directories that it would check. ## Verification All checks read a checkout pinned to the tag. - **First round:** authors, a release-notes audit, an audit of corrections stranded on `nightly`, an audit of 321 lines the last realign dropped from `main` (about 130 checked directly in code), and six fresh verifiers. - **Second round:** seven new verifiers re-checked every changed area, tracing behaviour rather than matching labels, and fixed about 50 more defects. That volume means more may remain. - **Limits of that second round:** - Each verifier reported what it only string-matched. That includes parts of Artifacts V1, the **Upgrade runner** notice, Copilot run behaviour, and some Plugin SDK contract text. - The second-round fixes themselves weren't reviewed by a third round. - **Gates:** `docs:build`, `docs:test` and `sync:check` pass. - **Nothing was run against a live instance.** All of this comes from reading code. ## Screenshots **196 of 278 screenshots are stale and none were recaptured.** The list is in `SCREENSHOTS_PENDING.md`. Some visibly differ from the text, such as the removed **Run with provider trace** button and the old roster tabs. ## After merge 1. Keep the PR title as is: `tag-docs-release.yml` reads the version from it. 2. Confirm the `docs/v2026.1106.0` tag exists. 3. Run `node scripts/sync/realign-nightly.mjs release/v2026.1106.0 --push`, then audit for dropped lines and duplicated paragraphs, and set `nightly` state back to `branch_mode: nightly`. 4. Check that `docs.paperclip.ing` serves the release: a new page, a new claim, and the changelog's top 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]>docs/v2026.1106.0 |
||
|
Aron PrinsandClaude Opus 5.5
|
dc84da0476 |
Hotfix: document database connection pool settings (v2026.1023.0) (#160)
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]> |
||
|
|
0ea1994fa7 |
Release docs for paperclip v2026.1023.0 (#156)
## 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]>docs/v2026.1023.0 |
||
|
Aron PrinsandClaude Opus 5.5
|
d811a89622 |
Screenshots: recapture all for v2026.1012.0 and align guides with the release UI (#150)
## Summary Every docs screenshot is retaken from Paperclip **v2026.1012.0**, in light and dark. Verifying them showed that about 50 guides described UI the release had moved or renamed, so those guides are updated too. **Screenshots** - 138 automated captures (276 PNGs), all stamped `v2026.1012.0` (`bba6a45`). The final run had no failed steps or skipped captures, and the luminance and theme check passes on all 278 files. - Four independent reviewers checked every light shot against its caption, then a fix round cleared the findings. - 37 captures (74 PNGs) are retired: none is embedded on any page, or the screen no longer exists in the release. - The capture pipeline (`scripts/screenshots/*`) is fixed for the release UI: - turns off the remote "Introducing Connectors" announcement that covered most shots; - masks local temp paths as `~/acme/…`; - keeps the demo company quiet during capture (no recovery loops, no capture-created activity rows); - seeds the states the guides describe: status cards, 50/80/100% budgets, a blocked inbox, schedule triggers, a checkbox confirmation, skills-capable agents and more; - uses updated routes and steps for the moved UI, and gains `scrollToTop`, `readyText`, per-target `experimental` flags, and comma lists for `--only`. - **The budget shots show a fixed incident card.** In v2026.1012.0 a warning-threshold incident is labelled "hard stop · This scope is paused", which is wrong. The fix is [paperclipai/paperclip#16201](https://github.com/paperclipai/paperclip/pull/16201). The costs and budget shots were captured from v2026.1012.0 with that patch applied, and the budget guides say so and explain what v2026.1012.0 itself shows. **Docs aligned with the release UI** - **Audit:** costs, budgets, runs and the timeline moved under Audit. That covers Costs and Budgets, Activity Log, Work Timeline, Set a monthly budget, and Dashboard. - **Agents:** the agent page's side menu (**Overview**, **Harness / Runtime**), the two-step **New agent** dialog, **Run now**, and the org chart as a view toggle. That covers Agents, Your first agent, Watching agents work, Key concepts, Org structure, Agent adapters and Adapters. - **Projects, routines, tasks, approvals:** current tabs, buttons and flows. - **Skills, plugins, company, settings:** current labels, including instant-join invites, the Experimental settings list, and **Settings → Experimental** paths on 21 pages. - **Removed features:** Auto-Create Recovery Tasks and Cloud Sync are marked as removed in this release. - Every rewrite was checked against the v2026.1012.0 UI source, then by two independent verifiers. A changelog entry is added under v2026.1012.0. ## Checks - [x] `npm run docs:build` - [x] `npm run docs:test` (all suites) - [x] `sync:lint-links` and `sync:verify-nav`: only the 4 intentional orphans remain - [x] SEO metadata and crawlable links ## Known, accepted - The activity feeds lead with agent setup events rather than task events. - The dashboard agent strip shows two cards for Ada. - Agent budgets can only be created from the CLI or API in this release, and the guides say so. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <[email protected]> |
||
|
|
2535f6c99c |
Release docs for paperclip v2026.1012.0 (#149)
## 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]>docs/v2026.1012.0 |
||
|
|
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]>docs/v2026.1005.0 |
||
|
|
186095cd39 |
Release docs for paperclip v2026.1001.0 (#142)
Release docs for paperclip **v2026.1001.0** (tag `8f8a0ab7`, 77 commits
from the `v2026.916.1` merge-base `dffc2b3`).
## What's in the release
Agent characters across the app, a rebuilt Slack setup, safe routine
webhooks, experimental MCP aggregators (default-off
`enableMcpAggregators`), Railway and You.com connectors, the CreateOS
sandbox provider, queued answers during active runs, and runner-created
company skills. Two breaking changes are documented: coding agents now
run in full auto by default, and the legacy Composio broker is retired.
## How this branch was built
This branch was cut from `nightly`, with `main` merged in. Nightly had
drafted parent `master` up to `0f14d261`, which is **93 commits past the
tag**. So every page changed against `main` was checked line by line
against the tag source, and post-tag content was reverted to what ships.
**Merge with `main`:** `main` published Fireflies, Railway, and You.com
guides in #138/#141 while nightly drafted its own versions. This branch
keeps `main`'s live versions. Nightly's Fireflies and Railway drafts
describe post-tag behaviour anyway.
## Changes
- 37 doc pages vs `main`, all stamped `paperclip_version: v2026.1001.0`.
One new page: `connectors/mcp-aggregators.md`.
- `docs/reference/changelog.md`: v2026.1001.0 entry. It also rounds up
the six connector guides published since v2026.916.1.
- Zapier, Arcade, Composio, and Executor pages and catalog rows now say
they need the experimental **MCP aggregators** setting. At the tag, all
four are filtered out of **Connectors** until it is on
(`packages/shared/src/remote-mcp-connectors.ts`). This is new for
Zapier, which used to be visible to everyone.
- The connector-model version notes in `connectors.md`,
`recognized-providers.md`, and `slack.md` are moved to v2026.1001.0.
- `SCREENSHOTS_PENDING.md`: regenerated for the release window. 194 of
350 screenshots are flagged across 40 routes (file-change flags only).
- `.sync-state.json`: base moved to `v2026.1001.0`.
### ⚠ Post-tag leaks removed
Present on `master`, absent at `v2026.1001.0`. These stay on `nightly`
for a later release.
- **Memory connectors** (Zep, Supermemory, Cognee, Honcho) and the
toggle, from `18dac1e1`: `connectors.md`, `connections-apps.md`,
`mem0.md`.
- **MCP aggregators on by default** and agent provider choice, from
`8781f06a`, `aa8fc863`, `b41ccf09`, `4721f558`: `mcp-aggregators.md`,
`connectors.md`. The `--retry-provider-choice`, `--target-service`, and
`--selection-interaction-id` flags are removed from
`cli/connections.md`.
- **Slack** governed tools, personal search, Idle state, scheduled
messages and `im:write`, message mirroring, channels enabled by default,
and the MCP-access troubleshooting row, from `a10702a8`, `b0155a68`,
`8725d6ce`, `a7d3b17a`: `slack.md`,
`wire-slack-discord-notifications.md`.
- **Fireflies routine signing**: the `app_webhook` and `fireflies_hmac`
modes, payload data blocks, and the Fireflies example, from `24429024`:
`routines.md` (guide and API) and `create-a-daily-routine.md`.
- **Tasks**: the artifact media gallery (`1ccae464`), Ancestors in the
Tasks panel (`2788f20f`), retry-budget escalation to `blocked`
(`6bc830b6`), and alphabetized experimental settings (`794b09f8`).
- **Settings**: per-user keyboard shortcuts and `/api/auth/preferences`
(`01d9a121`), the `PAPERCLIP_HIDDEN_SETTINGS` `instance.experimental.*`
wildcard (`e2f1a66a`), Cloud **Invite people** on Members (`c341588b`),
and the Cloud lifecycle routes (`8c6cc7dc`).
- **Plugin SDK**: the `organizationSwitcher` slot (`7badae69`) and the
environment-creation cleanup helpers (`1dbffb4c`).
- **Agents and adapters**: the model and reasoning-effort refresh
(`cdf04a33`), covering Opus 5.5, `gpt-6-sol`/`luna`, Gemini 3.8 Flash,
Grok 4.x, Kimi K3 256k, and the Cursor/OpenCode model lists. Also Grok
in the Cloud picker (`83abfa46`) and `inheritRuntimeFrom: "caller"`
(`7944ed3d`).
- **Retired `PAPERCLIP_WAKE_PAYLOAD_JSON`** (`4b8ec588`): restored in
`environment-variables.md` and `reference/skills.md`.
### ⚠ Verification Failures
For a reviewer to confirm:
- **Codex full auto on the ACP engine.** Per the verifier, at the tag
Codex's approval-and-sandbox bypass applies on the CLI lane, while the
default ACP engine keeps Codex in its workspace sandbox with network on.
`codex.md` now says so. `agent-adapters.md` → "Agents run in full auto
by default" still lists Codex without that qualifier.
- `GET /api/agent-avatars/{version}/{palette}/{pose}.png`
(`api/agents.md`) is medium-confidence drift. It is confirmed at the tag
in `server/src/routes/agent-avatars.ts`.
The mechanical tag-accuracy gate reported **0 high-confidence leaks**,
even on the unfixed nightly content. Every leak above is behavioural or
prose, and was caught by a per-page adversarial pass against the tag
source.
### ⚠ Drift
All pre-existing and known false positives:
- env-var-missing (high):
`PAPERCLIP_WORKSPACE_GIT_SCAN_{CONCURRENCY,QUEUE_CAPACITY,TIMEOUT_MS,CACHE_TTL_MS}`
and
`PAPERCLIP_ID_CONNECTOR_{BASE_URL,ENVIRONMENT,INSTANCE_ID,SIGN_PRIVATE_KEY,SEAL_PRIVATE_KEY}`,
which sit in grouped or commented `.env.example` blocks.
- Verify: rest-route-missing (medium): the five
`/api/companies/import/transfers*` routes, registered through
`COMPANY_IMPORT_TRANSFERS_ROUTE_PATH`.
### Open nightly-draft PRs
Local branches `nightly-draft/2a99de8-sandbox-and-routine-triggers` and
`nightly-draft/3e63a7e-acp-engine` are not part of this release.
### ☐ Before merge
- Delete the duplicate `docs/connectors/you-com.md` (nightly's draft;
`main`'s `youcom.md` is the registered page). It is an orphan with a
duplicate `seo_title`; the automated run could not delete files.
- Optionally run `npm run screenshots:refresh` on this branch.
## Checks
`docs:build`, `docs:test` (all six gates), `sync:lint-links`,
`sync:verify-nav`, and `sync:verify-screenshots` all pass locally. The
only new orphan is the duplicate `docs/connectors/you-com.md`.
🤖 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]>
docs/v2026.1001.0
|
||
|
Michael NguyenandPaperclip
|
fbed190ccb |
docs: add six shipped connector guides to the hub table (#141)
The connector hub omits six guides already shipped in #138. Add Arcade, Composio, Executor and Fireflies under Productivity and collaboration, Railway under Developer tools, and You.com under AI tools, linking to their existing guides. Fireflies is explicitly labelled **Live exception; not yet stable**. The rows retain the guides' unverified setup boundaries, Railway's pending live qualification, and You.com's reduced free profile. The diff is one file and six added table rows. Validation: doc-link resolution (1,978 checks), generated docs build and crawlable links (76,671 links), authored SEO metadata (266 pages), and git diff --check pass. Michael owns review and merge. LOOA-2949 stays open until the merged table is checked in production. Co-authored-by: Paperclip <[email protected]> |
||
|
Michael NguyenandPaperclip
|
c6fdf69a35 |
docs: add 46 connector overview backlinks at website launch (#139)
Add one Connector overview link to each of the 46 default-visible connector docs pages, pointing to its paperclip.ing/product/connectors/<slug>/ page. Exactly 46 files, 92 additions, zero deletions; no guide or navigation changes. Head: `b9a726134de314dff6094628875832ed459deb09`. Base: `main` at `51c70cb0a537afe3fb7cfba3cd7b269e27166610`, following the merged guides-only PR #138. GitHub reports MERGEABLE / CLEAN. No further rebase is needed. Validation refreshed at 2026-10-02T06:33:32.333294+00:00: - Both `Docs checks / docs-test` runs and Cloudflare Pages are successful for this head. Existing unchanged-head runs are reused. - Diff verified against all 46 approved slugs: exactly one matching overview link per file. - [Cloudflare deployment preview](https://029491b0.paperclip-docs-74t.pages.dev): all 46 connector docs pages return 200 and contain exactly one matching website overview link. This proves preview delivery, not production website acceptance. Hold this draft for the October 2 Pacific connectors launch. Michael alone performs each merge in order: website #126, docs #139, then article #116. Before this PR merges, website #126 must be deployed and all 46 production connector destinations must return 200 with final URLs recorded. Michael must confirm this exact PR/head separately at G6. Agents never merge. After docs deployment, record the website-to-docs deployment interval and crawl all 46 production docs backlinks/anchors. Release ownership: LOOA-2827 under P10. Production destination validation and G6 remain pending; no live-backlink acceptance is claimed. Co-authored-by: Paperclip <[email protected]> |
||
|
Michael NguyenandPaperclip
|
51c70cb0a5 |
docs: add six connector guides and navigation entries (#138)
Six default-visible connectors have no served docs page. This adds Arcade, Composio, Executor, Fireflies, Railway, and You.com guides and their navigation entries. The diff is exactly seven files. It contains no Connector overview backlinks, so these guides can ship before the website connector pages exist. The guides follow product definitions at `paperclipai/paperclip@3166e93a7eee315e3bfbda622e080044ec5c343d` and each provider's documentation. Every setup step and suggested check remains marked unverified; no live connection was tested. Immutable definition citations, aggregator permission boundaries, and Railway's pending live qualification are preserved. Docs base: `478d24ce5d851f5ff3dc3a97b76650940e79d628`. Validation: docs build, metadata, doc-link resolution, and rendered crawlable links pass. The 40 existing scoped connector pages match the docs base exactly. All 46 overview links are deferred to a separate draft PR for the website launch. Fresh CI and canary evidence are in the P3 review package. Michael must confirm this revised guides-only commit at G6 and perform the merge. P3 remains in review until these six docs routes are served. --------- Co-authored-by: Paperclip <[email protected]> |
||
|
Aron PrinsandClaude Opus 5.5
|
478d24ce5d |
ci: tag docs releases automatically on merge to main (#133)
Tags every docs release automatically, so the `docs/vX.Y.Z` tag stops depending on someone remembering to create it after the merge. So far, 11 of 16 releases were never tagged. ## What changes - **New workflow, `.github/workflows/tag-docs-release.yml`.** It runs on every push to `main`. For each new commit titled `Release docs for paperclip vYYYY.MDD.P`, it tags that commit `docs/vYYYY.MDD.P`. - Anything after a space in the title, such as `(#132)`, is ignored. - Pre-release versions like `-beta.1` are skipped. - Tags that already exist are left alone. - **`skills/sync-docs/SKILL.md` (Phase 9) and `maintenance/runbook.md`.** The after-merge step now checks that the tag exists instead of creating it by hand. It also tells you to keep the release PR title format, because the workflow reads the version from it. ## Tested I ran the version matching against all 16 release squash-commit titles on `main` and it matched every one, including `(content + screenshot overhaul) (#95)` and titles with no PR number. It rejects `-beta.1`. The workflow itself hasn't run on GitHub yet; the next release merge will be its first run. ## Needs The workflow needs permission to push tags: `permissions: contents: write`. If the repo's Actions permissions are read-only and that can't be changed per workflow, the first run will fail with a clear error. Fix it in Settings → Actions → Workflow permissions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 5.5
|
a3368fb06b |
Release docs for paperclip v2026.916.1 (#132)
Release docs for paperclip **v2026.916.1**, a patch on top of v2026.916.0. ## What's in the release One upstream commit, [#13562](https://github.com/paperclipai/paperclip/pull/13562): the task conversation's send button no longer starts out disabled while the pause check loads. The same commit repairs how the server classifies duplicate document inserts. No doc page described the broken behavior, so no content needed editing. ## Changes - `docs/reference/changelog.md`: a v2026.916.1 entry. It also lists the pages published on `main` since v2026.916.0: Set Up HTTPS, Understanding GitHub PR review bots, and Set up a GitHub review bot, plus updates to Trust & Low-Trust Review and the GitHub connector pages. - `SCREENSHOTS_PENDING.md`: 24 task-detail screenshots whose dependencies changed. These are file-change flags, not confirmed visual changes, so recapturing is optional. - `.sync-state.json`: base moved to `v2026.916.1`. This branch was cut from `main`, not `nightly`. Everything on `nightly` was drafted from parent `master` after the tag, so none of it is included. ### ⚠ Post-tag leaks removed The following nightly drafts are absent at `v2026.916.1` and were deliberately left out: - `docs/reference/adapters/sandbox-providers.md`: the CreateOS provider. The tag-accuracy gate flagged it as a leak. - `docs/guides/projects-workflow/routines.md` and `docs/reference/api/routines.md`: webhook setup-pending and test deliveries. `routines.ts` at the tag has no webhook handling. ### ⚠ Verification Failures For review: the tag-accuracy gate could not confirm the surface of `docs/connectors/github-review-bot-setup.md` or `docs/connectors/understanding-github-review-bots.md` at the tag. Both are marked experimental and already live. ### ⚠ Drift These items predate this patch; they shipped with v2026.916.0. - env-var-missing (high): `PAPERCLIP_WORKSPACE_GIT_SCAN_{CONCURRENCY,QUEUE_CAPACITY,TIMEOUT_MS,CACHE_TTL_MS}` and `PAPERCLIP_ID_CONNECTOR_{BASE_URL,ENVIRONMENT,INSTANCE_ID,SIGN_PRIVATE_KEY,SEAL_PRIVATE_KEY}` in `environment-variables.md`. These may be runtime-injected false positives. - Verify: rest-route-missing (medium): the five `/api/companies/import/transfers*` routes in `api/companies.md:426-430`. ## Checks `docs:build`, `sync:check`, and `docs:test` all pass locally. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>docs/v2026.916.1 |
||
|
DottaandPaperclip
|
29a78936e5 |
docs: explain and set up experimental GitHub review bots (#130)
## Thinking Path > - Paperclip runs agent work as tasks and runs. > - The experimental GitHub chat connector lets GitHub conversations and PR events enter those tasks. > - Installing an App, scheduling reviews, and requiring a passing check are independent choices. > - Readers need both that explanation and a concrete setup tutorial. > - These guides pair the mental model with a Storybook reviewer that can be tested from failure to success. ## What Changed - Group all four GitHub pages under an expandable GitHub sidebar section, with matching breadcrumbs. - Add **Understanding GitHub PR review bots**, preserving the conversational explanation of installation, triggers, scores, checks, and formal reviews. - Add a separate **Set up a GitHub review bot** tutorial with a copyable Storybook instruction, agent/runtime prerequisites, App registration and installation, repository selection, identity linking, and required-check configuration. - Mark both pages as experimental chat documentation and cross-link them. Update the older GitHub pages to remove conflicting legacy setup advice. - Include four real setup UI screenshots in both themes, using explicitly labeled demo responses. Register all eight images for reproducible capture and source-change tracking. - Add a screenshot-only fixture and small capture helpers for native selects, required content, and a configurable local port. ## Verification - Latest-head GitHub `docs-test` and Cloudflare Pages checks passed at `b4e7943f8e77bc3320ea6eb0379dd1ff65f87a98`. - Deployed preview browser-checked: [understanding review bots](https://5e364a56.paperclip-docs-74t.pages.dev/connectors/understanding-github-review-bots/) and [setup tutorial](https://5e364a56.paperclip-docs-74t.pages.dev/connectors/github-review-bot-setup/). - GitHub sidebar collapse/expand and navigation between nested pages checked in the embedded browser. - Both pages checked in the embedded browser. Followed the cross-links in both directions and verified all four images load in light and dark themes. - All eight screenshots captured from the actual UI at Paperclip revision `7ba761fe007bb798400d3e62346fa964f607f0f8`. No live GitHub credentials or agent runs are represented by these fixtures. - `npm run sync:lint-links`, `npm run sync:verify-nav`, and `npm run sync:verify-screenshots` passed. Navigation reports only the three pre-existing unlisted/orphan pages. - `npm run docs:build` and the complete `npm run docs:test` suite passed, including static routes, sitemap history, asset fingerprints, navigation, crawlable links, source blocks, 1,945 link-resolution checks, and SEO metadata. - Reviewed the current GitHub documentation for required checks, expected App sources, and neutral results. ## Risks The chat feature is experimental and the UI may change. Screenshot dependencies and capture commands are recorded for refreshes. The tutorial distinguishes illustrative UI captures from the live acceptance tests readers must perform. This changes documentation and its screenshot pipeline only. ## Model Used OpenAI GPT-6 through Codex, using repository tools and the embedded browser. The precise serving model variant and context-window size were not exposed. ## Checklist - [x] Both requested pages exist and cross-reference each other. - [x] Both identify the experimental chat feature. - [x] Screenshots include light and dark themes with capture provenance. - [x] Documentation build and targeted verification passed. - [x] Complete docs test suite and PR checks passed. --------- Co-authored-by: Paperclip <[email protected]> |
||
|
Dotta
|
8d83401d7b |
docs: explain low-trust agents for GitHub review bots (#129)
GitHub review bots read code and conversation text supplied from outside the company. This adds a dedicated section to the existing low-trust review page explaining the agent preset, concrete work boundary, isolated sandbox, governed connection tools, and the separate limits of guest sponsorship. The approved connector setup links to this existing page and warns when the chosen agent uses standard trust. Choosing the warning does not silently change the agent policy. Validation: documentation build passed for 258 pages. No site configuration or navigation changes. Model: OpenAI GPT-6 through Codex, using repository inspection, editing, and build tools; exact serving model ID/context size were not exposed. |
||
|
Dotta
|
480c133b1f |
docs: explain HTTPS setup for self-hosted Paperclip (#128)
Some Connections need a trusted HTTPS callback, and self-hosters need to distinguish private browser access from public provider webhooks. Add a setup guide covering HTTPS included with Paperclip Cloud, private Tailscale Serve, a separate Funnel callback route, and Caddy on a custom domain. The guide includes Paperclip's authenticated deployment settings, canonical and webhook origins, certificate requirements, and verification. Add it to Deployment navigation and cross-link the existing overview and Tailscale private-access pages. Validation: production docs build, full docs test suite, internal-link lint, and diff checks. Examples checked against Paperclip configuration and official Tailscale/Caddy documentation. No runtime or deployment configuration changes. |
||
|
|
c65bc9a9bf |
Release docs for paperclip v2026.916.0 (#125)
Brings **paperclip-docs** in line with paperclip **v2026.916.0**, shipping the `v2026.831.1 → v2026.916.0` cycle drafted on `nightly`, stamped to the release tag, with a documentation changelog entry. This branch was cut from `nightly` **after** merging `origin/main` into it, so it sits on top of the operator-first connectors catalog (#124) rather than reverting it. ## Manifest **New pages (4)** - `docs/reference/api/connection-intents.md` — Connection Intents API - `docs/reference/cli/connections.md` — `connections` command - `docs/reference/cli/managed-agent.md` — `managed-agent` command - `docs/reference/cli/test-drive.md` — `test-drive` command **Updated pages (17)** - Roles & Permissions + Company Administration — `tools:*` role-default changes - Connect an Agent to GitHub — managed GitHub connection (Connectors), Option C - Agents API — Managed/Remote Agent Profiles, `***REDACTED***` env serialization - Tool Gateway API — agent self-authorization (`start-authorization`, `token`) - Instance Admin API — instance-settings + task-drain routes - Plugin SDK — `ctx.access` + `ctx.authorization` clients, login-PTY/duplex streaming - Environment Variables — Paperclip ID Connector block + HTTP adapter allowlist var - Adapters: Codex (`gpt-5.6-sol` default, Fast mode, auth cache), Claude Code (Fable 5.1 + CLI floor), Grok Local (SuperGrok subscription auth), HTTP (SSRF guard), Sandbox Providers (Daytona warm runner), OpenCode (model pre-flight) - CLI: `adapter detect-model`, `onboard` tool-action signing secret - Command palette — recent tasks in sidebar - `docs/reference/changelog.md` — new `v2026.916.0` accordion entry All 21 touched pages stamped `paperclip_version: v2026.916.0`. ## Verification **Tag-accuracy gate (Phase 5.7)** — `check-tag-accuracy.mjs --tag v2026.916.0 --base main --head nightly` flagged 5 pages, **every one verified present in the code at the release tag** and cleared as known `verify-edit` false-positive classes. No content was quarantined; **no post-tag leaks**: | Page | Flagged claim(s) | Verified at tag | |---|---|---| | `cli/connections.md` | `PAPERCLIP_RUNTIME_TOOLS_*` (3) | present in `cli/src/commands/client/connections.ts` (runtime-injected env) | | `cli/managed-agent.md` | `--profile-key`, `--api-key-secret-id` | present in `cli/src/commands/managed-agent.ts` (`.requiredOption`/`.option`) | | `cli/test-drive.md` | `--harness` | present in `cli/src/commands/test-drive.ts` (`new Option`) | | `deploy/environment-variables.md` | `PAPERCLIP_ID_CONNECTOR_*` (5) | present in `.env.example` at tag | | `plugins/sdk.md` | `PLUGIN_*` (6) | present in `packages/plugins/sdk/src/index.ts` (exported constants) | Rationale: nightly's drafts were authored from parent `af8439a`, **226 commits inside the tag**, so they document in-tag surfaces by construction. ### ⚠ Drift `check-drift.mjs --against v2026.916.0` returned 14 records — **all verified present at the tag** (checker false positives), listed here for the reviewer to confirm: - **env-var (9, high-confidence in the tool, verified present):** `PAPERCLIP_WORKSPACE_GIT_SCAN_{CONCURRENCY,QUEUE_CAPACITY,TIMEOUT_MS,CACHE_TTL_MS}` and `PAPERCLIP_ID_CONNECTOR_{BASE_URL,ENVIRONMENT,INSTANCE_ID,SIGN_PRIVATE_KEY,SEAL_PRIVATE_KEY}` — all present in `.env.example` at the tag; the drift scanner's scoped file scan missed them. - **Verify: rest-route (5, medium-confidence):** `POST/PUT/GET /api/companies/import/transfers*` — present at the tag in `server/src/routes/companies.ts`, registered via the `COMPANY_IMPORT_TRANSFERS_ROUTE_PATH` prefix constant (the documented prefix/dynamic-registration blind spot). ### ⚠ Verification Failures None. All tag-accuracy and drift flags above were verified present at the tag. ### ↻ Renames detected None. The connectors catalog (`docs/connectors/**`) arrived via the `main` merge (#124), not as a renamed surface; no new top-level draft directories were introduced this cycle. ## Screenshots **238 of 342 screenshots** flagged stale across 50 routes (see `SCREENSHOTS_PENDING.md`). This is a wide 16-day window touching ~921 UI files, so most are dependency-touch flags rather than confirmed visual changes. Recommend `npm run screenshots:refresh` on this release branch as a dedicated follow-up before merge; PNGs go to a separate PR for human review. ## Build gates (all green on this branch) - `npm run docs:build` — 257 pages - `npm run docs:test` — SEO metadata, crawlable-links (71,749 links resolve), doc-link-resolution, skill-source-blocks, static-routes, hierarchical-nav ## Post-merge checklist (Phase 9 — do NOT skip) - [ ] Squash-merge this PR (repo is squash-only) - [ ] `git checkout main && git pull` - [ ] `git tag docs/v2026.916.0 && git push --tags` - [ ] `node scripts/sync/realign-nightly.mjs release/v2026.916.0 --push` (restore ancestry; keep nightly post-tag drafts) - [ ] Flip `nightly` `.sync-state.json` back to `"branch_mode": "nightly"` (leave `base_release_tag` at `v2026.916.0`) - [ ] Verify `docs.paperclip.ing` serves the release: a new page (`/reference/cli/test-drive/`), a changed page, and the changelog top entry reads `Docs for v2026.916.0` - [ ] If production is stale, republish: `npm run docs:build && npx wrangler pages deploy .site --project-name paperclip-docs --branch main` 🤖 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]>docs/v2026.916.0 |
||
|
|
39633c2217 |
docs: connectors catalog, operator-first third revision (#124)
Connector catalog, setup guides, and shared access documentation, followed by a final code-accuracy repair pass. This PR does not change application behavior. ## Final accuracy pass Checked against shipped Paperclip `v2026.916.0`, commit `dffc2b3ca1b9e88fa21cb17493083e682dffd1ca`, rather than the dirty local checkout or the earlier canary baseline. - Corrects connector/method-specific identity choices, human audiences, and managed GitHub versus PAT scope and verification. - Explains that **Always allow** covers different arguments for the same agent/action/connection, with project scope when present; uses actual button labels and removes the test-panel control from review instructions. - Qualifies new-action quarantine, including safe-default read exceptions. Removes unconditional approval guarantees. - Separates provider channel/repository reach from Paperclip sender authorization. - Completes sandbox sign-in and model credential-selection instructions from the current UI implementation. - Repairs Notion's hub summary, removes incomplete optional Notion/Sentry client-registration procedures, and corrects Linear's provider-versus-Paperclip attribution. - Removes unsupported Postman tier claims, contradictory Cloudinary/Mem0 verification assertions, API-equivalence claims, and overbroad successful-test assurances. - Retains Supabase's required project reference: both released method definitions explicitly require it. An earlier review suggested otherwise; release code is authoritative here. - Updates the release baseline and removes draft commit chronology from the public introduction. ## Availability and remaining runtime gates - **Google:** Verification is pending. Per the product-owner clarification, authorization can continue where Google offers an Advanced option; this is not available for every account and does not override Workspace policy or other Google prerequisites. Notices on the hub and all Google guides now distinguish an unverified-app warning from blocked authorization. - **Slack is available but not yet fully functional; follow-up fixes are planned.** For agent tools, the released OAuth endpoint/scope defaults differ from Slack's documented MCP contract. The page now warns against treating that route as production-ready and removes the misleading bot-scope walkthrough. Chat-channel bot setup remains separate. Engineering must reconcile the integration and run OAuth plus one read before removing this warning. Source: https://docs.slack.dev/ai/slack-mcp-server/ - No credentialed connector run was performed in this pass. Code consistency, provider documentation, UI rendering, and successful live execution are separate evidence levels. No claim of runtime certification for all connectors. ## Validation - Root build: 253 crawlable documentation pages. - Full `docs:test`: all eight suites passed locally, including root/subpath routes, sitemap history, fingerprints, navigation, skill source blocks, crawlable links, doc-link resolution, and SEO metadata. - Internal-link lint: 258 Markdown files; no broken internal links. - Latest cleanup: full build, all eight docs:test suites, internal-link lint and diff whitespace checks passed; 1,878 link-resolution checks. - Fixed the Calendar MCP reference URL; browser-checked the five inconclusive external destinations (Miro article loads; Asana, Google Cloud, OpenAI and xAI reach sign-in/console screens). Authenticated destinations were not tested beyond those screens. - Replaced the Sandbox providers editorial TODO with a scope note and removed the CLI overview's unfinished-guide announcement. - Browser client navigation: 687 checks passed using installed Chrome. Initial launch lacked the downloaded Playwright browser; rerun used `DOCS_CHROMIUM_PATH` without changing the tests. - Nine representative connector/shared pages at 1440px and 390px: HTTP 200, one article H1, no page-level horizontal overflow. Mobile screenshot inspected; approval page opened in the Codex browser. - Navigation audit reports three existing non-connector orphan files; this patch does not alter those files or their navigation. The previous revision's provider-page expansion, Google shared setup guide, navigation additions, and accidental node_modules-symlink cleanup remain in this PR. Internal review ledgers remain outside the publication branch. No merge or production deployment authorized. --------- Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> Co-authored-by: Claude Opus 5 (1M context) <[email protected]> Co-authored-by: Michael Nguyen <[email protected]> |
||
|
Michael Nguyen
|
9f46125a8d |
Add unlisted hosted beta guide and FAQ (#122)
## Summary
Adds the hosted beta getting-started guide and FAQ at `/hosted-beta/`,
using the existing docs header, sidebar, article layout, theme controls,
and table of contents.
The page remains outside the navigation/search manifest, homepage
listings, previous/next links, and sitemap, with a `noindex` directive.
Direct-link visitors can navigate into the regular docs. This is a
public, unlisted page rather than access-controlled content.
## Validation
- Root and subpath builds and unlisted discovery checks pass.
- Existing static route verification passes.
- Desktop and mobile browser checks show no overflow or runtime errors.
- Table-of-contents anchors and navigation into regular docs verified.
Local preview: http://127.0.0.1:4337/hosted-beta/
Hosted preview:
https://aa3d8178.paperclip-docs-74t.pages.dev/hosted-beta/
Cloudflare deployment succeeded for commit
|
||
|
Aron PrinsandClaude Opus 4.8
|
27d7a5ab4c |
Release docs for paperclip v2026.831.1 (#120)
Syncs docs to parent release **v2026.831.1** (cumulative from
`v2026.824.1`, via merge-base `664052f`). Authored fresh against the
release tag; every claim verified at the tag.
## What changed
**New**
- **Kimi Code adapter** (`kimi_local`) — new reference page, wired into
the adapters overview, nav, and anchor-map source mapping.
**Reference**
- **Env vars** — `PAPERCLIP_WORKSPACE_REAPER_COOLDOWN_DAYS`, opt-in
`SENTRY_DSN`, and the operator controls `PAPERCLIP_HIDDEN_SETTINGS` /
`PAPERCLIP_SETTING_DEFAULTS`.
- **Instance Settings** — new "operator controls for hosted deployments"
section (hide surfaces / override defaults).
- **Node.js floor → 24.11.0** across installation, setup,
local-development, plugin dev, Modal, and the getting-started/terminal
guides.
- **Grok adapter** — `permissionMode` no longer defaults to `dontAsk`;
when unset no flag is passed, and `--always-approve` is the unattended
policy.
- **CLI `agent`** — Kimi skills install path (`~/.kimi-code/skills`) +
`KIMI_CODE_HOME`.
**Guides**
- **Onboarding** — rebuilt around a single-card wizard that opens on
creating your agent; the mission step is gone, the goal is set
afterward.
- **Settings unification** — Invites folded into a Members tab, one
shared settings nav, and the company brand color + per-company
attachment size limit removed (also reflected in the Companies and Cases
APIs).
- **Governance behavior** — silent-run detection and stranded-task
recovery no longer act on their own; agent thought text is excluded from
automatic comments; invalid agent credentials now return `401`.
**Changelog** — entry added for v2026.831.1.
## Gates
- `docs:build`, SEO metadata, crawlable-links, sitemap-lastmod
(194/194), lint-links, verify-nav — all pass.
- **Edit verification:** every new high-confidence claim verified at the
tag.
- **Tag-accuracy gate:** 31 files checked, **0 post-tag leaks**, 30
clean, 1 review (below).
## ⚠ Drift (Verify before acting — not auto-resolved)
Medium-confidence REST-route drift in `docs/reference/api/companies.md`
— the import-transfer routes may no longer exist at these paths (likely
a false negative from prefix/dynamic registration; confirm before
editing):
- `POST /api/companies/import/transfers`
- `PUT /api/companies/import/transfers/{transferId}/parts/{partIndex}`
- `GET /api/companies/import/transfers/{transferId}`
- `POST /api/companies/import/transfers/{transferId}/preview`
- `POST /api/companies/import/transfers/{transferId}/apply`
## ⚠ Review
- `docs/reference/adapters/kimi-local.md` — new page; the only flagged
claim is the `secret-id` JSON **example placeholder** (not a real
identifier). Authored directly from the adapter's config surface at the
tag.
## Screenshots (deferred)
288 of 342 registered screenshots are stale (org-wide rename +
settings/onboarding rewrites), tracked in `SCREENSHOTS_PENDING.md`.
Recapture is a follow-up pass — **the merged pages describe the new
onboarding/settings UI while screenshots still show the old flow until
then.**
---------
Co-authored-by: Claude Opus 4.8 <[email protected]>
docs/v2026.831.1
|
||
|
Aron PrinsandClaude Opus 5
|
4644dda3a3 |
test: guard sitemap lastmod against shallow clones and metadata sweeps (#119)
Picks up the regression test from #104 (@cryppadotta) — closed as superseded, but its fixture design was the best part of it and worth landing on its own. ## Why this gap mattered The sitemap `lastmod` bug shipped twice, and **neither failure was detectable by any check in `docs:test`**: | | Symptom | Why nothing caught it | |---|---|---| | #117 | 0 dates in production for weeks | Shallow checkout doesn't make `git log` *fail* — it succeeds, returning one date per file | | #118 | 192 concurrent `git fetch --unshallow` fighting over `.git/shallow.lock`, dateless sitemap | Reproduces only on a shallow clone — never locally, never in CI | Both are Cloudflare-only failure modes. The only detector we had was reading the live sitemap, which is how this whole thread started. ## What landed `scripts/verify-sitemap-lastmod-history.mjs`, wired into `docs:test`. Three cases against **real depth-1 clones** — the fixture design and `--no-local` insight are @cryppadotta's: 1. Full history publishes real per-document dates 2. Shallow clone that can reach origin recovers history 3. Shallow clone with unreachable origin omits dates rather than lying Two changes on top of the original: **Overlay the working-tree builder into the clone.** The clone carries committed HEAD, so without this the shallow cases silently test the last commit instead of the change being made. No-op in CI; the difference is real locally, and it is what makes the check usable while iterating. **Assert no single date covers >75% of pages.** The existing "more than one distinct date" assertion passes at *2* distinct dates — precisely the state #118 fixed, where 190 of 193 pages carried the date of a frontmatter-only sweep. Bounding the largest cluster catches that class without pinning a date that legitimate edits will move. ## Verified by breaking it A check that has never failed proves nothing, so I reverted each fix in turn: **Revert body-aware dating (#118):** ``` ok lastmod values vary across documents (2 distinct) rather than one build date FAIL full history: no single date dominates (2026-08-25 covers 190/193, 98% <= 75%) ``` Note the pre-existing assertion passing right above the failure — that is the gap this closes. **Revert the single-flight memo (#118):** ``` FAIL unshallowed build dates every route (2/193) FAIL unshallowed build produces varied dates (1 distinct) ``` The `.git/shallow.lock` race, caught by Case 2 and nothing else. Restored, clean run is green: 193/193 dated, 31 distinct, largest cluster 28%. ## Cost **~55s** added to `docs:test` for three builds (`docs-test` was 32s). Steep for a test suite, and worth flagging rather than burying — but the alternative detector for this failure class is noticing the live sitemap is wrong. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 5
|
c593c23233 |
seo: date sitemap entries by body changes, not frontmatter sweeps (#118)
Follow-up to #117. That PR got `<lastmod>` publishing at all; this one makes the dates worth resubmitting. ## The problem **190 of 193 pages read `2026-08-25`** — the date of #115, which added `seo_title`/`seo_description` to all 192 pages. Here is everything it changed in a representative file: ```diff +--- +seo_title: "Key Concepts: Companies, Agents, Tasks" +seo_description: The seven ideas behind Paperclip — company, agent, task... +--- + # Key Concepts ``` Not a word of prose. `lastmod` is meant to carry the date a page's **content** last changed, so resubmitting this hands Search Console the "whole site changed at once" signal that `dropUniformLastmod` and the shallow-checkout guard both exist to prevent. It cleared `dropUniformLastmod` only because 3 pages happened to differ. ## The fix Walk each file's history and report the newest commit that changed the **rendered body** — comparing `parseFrontmatter().body` across consecutive commits, so frontmatter-only commits are skipped. Reusing the build's own parser means the body compared is exactly the body the site renders. | | Before | After | |---|---|---| | Distinct dates | **2** | **31** | | Largest single-date cluster | 190 pages | 54 pages | | Range | 2 days | 2026-04-17 → 2026-08-27 | Top of the new distribution: | Date | Pages | |---|---| | 2026-08-18 | 54 | | 2026-06-04 | 21 | | 2026-08-25 | 17 | | 2026-07-08 | 16 | | 2026-07-20 | 15 | | 2026-04-22 | 12 | Spot-checked both directions: - `key-concepts.md` — last touched by the frontmatter sweep, now dates to **2026-07-08**, the commit that changed "Claude Local" to "Claude Code" in the body. - `day-to-day/issues.md` — **keeps 2026-08-25**, because release commit `6c4519a` that day added a real "Who may resolve a card" section. Its frontmatter-only `paperclip_version` bump in the same release was correctly skipped. ## Two supporting fixes **Concurrency.** ~600 git round-trips in series cost 40s. Resolving them in parallel: **11s**. **A race the concurrency exposed** — and the reason this is worth reading closely. `hasTrustworthyGitHistory()` memoised its *resolved value*, so once all 192 pages asked at once, every one of them passed the guard before the first resolved: ``` Could not deepen the shallow checkout: fatal: Unable to create '.git/shallow.lock': File exists. Still shallow: omitting sitemap <lastmod> rather than dating every page alike. × 192 ``` 192 concurrent `git fetch --unshallow` calls fighting over the lock, and **a sitemap with no dates at all**. This only reproduces on a shallow clone — which is to say only on Cloudflare Pages, never locally or in `docs-test`. Fixed by memoising the promise (single-flight). ## Verification | Scenario | Result | |---|---| | Full clone | 193 dates, 31 distinct, 11s | | `git clone --depth 1` (reproduces CF) | one unshallow, **193 dates, 31 distinct** | | Shallow + unreachable remote | no dates, exit 0 | | `npm run docs:test` (6 suites) | pass | | `npm run sync:test` | 39 pass, 0 fail (+1 new) | New unit test covers the `--follow --name-status` rename parsing — 55 docs files have been renamed, and reading the wrong field silently drops their pre-rename history. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 5
|
fe81cdf5a9 |
seo: publish sitemap lastmod dates from Cloudflare Pages builds (#117)
## The problem
`https://docs.paperclip.ing/sitemap.xml` contains **zero `<lastmod>`
elements** — 192 pages plus the root, none dated. It has never shipped
one.
The empty line after each `<loc>` is the tell: production *is* running
the current template, it just has nothing to emit.
```xml
<url>
<loc>https://docs.paperclip.ing/guides/welcome/key-concepts/</loc>
</url>
```
## Why
Dates come from per-file git history. The guard added in #113 suppresses
them on a shallow checkout, and it is right to — with one commit, `git
log -1` reports that commit's date for *every* file, so the sitemap
would claim the whole site changed at once and Google would learn to
discount the signal.
Cloudflare Pages builds from a depth-1 clone, and **its clone depth is
not configurable from this repo**. `docs-checks.yml` sets `fetch-depth:
0` for exactly this reason, but that workflow only checks the build —
Pages' Git integration is what deploys. So the guard fired on every
production deploy since #113.
Reproduced locally:
| Build environment | `lastmod` entries |
|---|---|
| Full history | 193, real varied dates |
| `git clone --depth 1` | 0 — output byte-identical to production |
## The change
Try `git fetch --unshallow` (90s timeout) before giving up, and log
which branch it took so the Cloudflare build log answers the question
directly.
## Verification
| Scenario | Result |
|---|---|
| Shallow clone, fetchable remote | 1 commit → 257, **193 dates
emitted** |
| Shallow clone, unreachable remote | logs the git error, omits dates,
**exit 0** |
| Full clone (unchanged path) | unaffected |
| `npm run docs:test` (6 suites) + `npm run sync:test` (38 tests) | pass
|
## What this PR cannot prove
The local test cloned from a `file://` remote, which can always fetch.
**Whether Cloudflare's build container keeps usable credentials for the
remote it cloned from is the entire open question**, and only a real
deploy answers it — hence this PR and its preview.
- Works → preview `sitemap.xml` carries dates, build log says `Full
history fetched`.
- Doesn't → build log says `Could not deepen the shallow checkout:
<reason>`, sitemap is exactly what we ship today. No regression either
way; fall back to deploying from Actions with `fetch-depth: 0`.
## Known, not fixed here
Even with full history, **190 of 193 pages date to `2026-08-25`** —
|
||
|
Aron PrinsandClaude Opus 4.8
|
5457a4ff38 |
Release docs for paperclip v2026.824.1 (#116)
Release docs sync for **paperclip v2026.824.1** (cumulative window
`v2026.824.0 → v2026.824.1`, 4 commits / 12 files). This patch release
repairs the onboarding background-service flow end to end.
## Change manifest
| Watcher | Parent files | Kind | Docs target |
|---|---|---|---|
| cli-commands | `cli/src/commands/onboard.ts`,
`cli/src/onboard-service.ts` | modified |
`docs/reference/cli/setup-commands.md` |
**`docs/reference/cli/setup-commands.md`** (`onboard` section) — once
the background service is installed, onboarding now hands you off to the
running instance: it waits for the port the service actually bound
(fallback port if the configured one is busy), prints the dashboard URL,
and opens it in your browser on interactive terminals. Headless runs
print the URL; the new **`PAPERCLIP_NO_BROWSER=1`** opts out of the
browser launch. If the service doesn't come up, onboarding points at
`paperclipai service logs` instead of claiming success.
`paperclip_version` bumped to `v2026.824.1`.
**`docs/reference/changelog.md`** — new `v2026.824.1` docs-changelog
entry.
Not doc-worthy this window: `run.ts` runtime-info plumbing, the
`paperclipai doctor` diagnostic-message refinements, and the test files
— no new or now-wrong surface in our docs.
## Verification
- `docs:build` ✓ · `sync:check` ✓ · full `docs:test` (6/6) ✓
- **verify-edit** against `v2026.824.1`: **47 claims verified, 0
unverified, 0 suspicious**. `PAPERCLIP_NO_BROWSER` and `paperclipai
service logs` both confirmed in parent code at the tag.
- **Tag-accuracy (Phase 5.7):** self-contained release — `nightly`
carries no doc drafts (only `.sync-state.json` differs from `main`), so
there are no post-tag leaks to quarantine.
- **Screenshots:** window touched only `cli/**`, no `ui/src/**` —
nothing stale.
## ⚠ Drift
Investigated against `v2026.824.1`. The two previously high-confidence
CLI findings (`paperclipai binary`, `paperclipai into`) were **scanner
false positives** — the drift scanner was reading `paperclipai <word>`
out of `seo_description` frontmatter prose. Fixed in this PR
(`scripts/sync/check-drift.mjs` now skips the YAML frontmatter block);
both disappear.
Remaining (5, medium, `Verify:` — **confirmed correct, no action
needed**):
- `POST /api/companies/import/transfers` ·
`docs/reference/api/companies.md:433`
- `PUT /api/companies/import/transfers/{transferId}/parts/{partIndex}` ·
:434
- `GET /api/companies/import/transfers/{transferId}` · :435
- `POST /api/companies/import/transfers/{transferId}/preview` · :436
- `POST /api/companies/import/transfers/{transferId}/apply` · :437
These routes **exist** at `v2026.824.1`
(`server/src/routes/companies.ts` lines 696/762/825/944/958), registered
via the `COMPANY_IMPORT_TRANSFERS_ROUTE_PATH` constant from
`@paperclipai/shared`. The scanner only matches string-literal paths, so
constant/template-literal registration reads as a false negative — a
known medium-tier limitation. The docs are accurate; nothing to change.
(A follow-up could teach the resolver to follow cross-package path
constants.)
## Checklist
- [x] Cumulative diff from last release tag
- [x] Edits verified against the release tag
- [x] Build + link + SEO + crawlable gates pass
- [x] Drift investigated; false positives fixed at the scanner, false
negatives confirmed correct
- [x] Docs-changelog entry added
- [ ] After merge: tag `docs/v2026.824.1`, realign `nightly`, verify
`docs.paperclip.ing` serves the release
---------
Co-authored-by: Claude Opus 4.8 <[email protected]>
docs/v2026.824.1
|
||
|
Aron PrinsandClaude Opus 5
|
325c9eb819 |
seo: hand-write titles and descriptions for all 192 pages (#115)
## Why
The build derived `<title>` from the **sidebar label** and the
description from the **first paragraph clipped to 220 characters**. Both
are the wrong source. A sidebar label is written for a 240px-wide nav
that supplies its own context; a search result has none.
On production that produced:
- **7 pages titled "Overview"**, and 32 pages sharing a title with
another page
- **109 of 193 descriptions cut off mid-word**, and 174 over 160
characters (where Google truncates)
```
/guides/welcome/key-concepts/
BEFORE (220): ...and if you misunderstand them early, the product wi
```
Near-identical titles are the weak-differentiation signal behind
"crawled — currently not indexed", which is the exact symptom on this
property.
## What changed
`seo_title` and `seo_description` frontmatter on **every one of the 192
pages**, written by hand against each page's real content and optimised
for the click — lead with what the reader can do, name the concrete
things covered, no keyword stuffing, no repeating the title.
| | Before | After |
|---|---|---|
| Duplicate titles | 32 pages | **0** |
| Duplicate descriptions | — | **0** |
| Descriptions cut mid-word | 109 | **0** |
| Descriptions over 160 chars | 174 | **0** |
| Title length (incl. suffix) | up to "Overview" | **26–60** |
| Description length | 31–240 | **122–158** |
**No prose was rewritten.** I measured content overlap between the
colliding pairs first — only 17–23%, so these were always distinct pages
wearing the same label, not duplicate content. The `docs/` diff is **564
insertions, zero deletions**.
### Examples
```
BEFORE — all seven identical: "Overview | Paperclip Docs"
AFTER: "Adapters Overview" "API Overview" "CLI Overview"
"Deployment Overview" "Bundled Skills" "Optional Skills"
"Experimental Features"
BEFORE — both identical: "Issues | Paperclip Docs"
AFTER: "Issues: Creating and Tracking Work" /guides/day-to-day/issues/
"Issues API" /reference/api/issues/
```
```
/guides/getting-started/five-minute-path/
BEFORE (220): The shortest route from a running Paperclip instance to an agent that has
just completed work for you. After Paperclip is installed, the path takes
about 5 minutes: create a company, hire a CEO agent, approve its first s
AFTER (131): Install Paperclip, create a company, hire a CEO agent, and approve its
first strategy — a working AI company in about five minutes.
```
## Plumbing
- **`site/build-release.mjs`** prefers the authored fields; the derived
path stays only as a fallback the CI gate prevents ever reaching.
`<title>`, `<meta name="description">`, and the `TechArticle` JSON-LD
all read from the same source.
- **`site/app.js`** uses the same fields, so a client-side transition
cannot leave a different title on screen than the crawler was served.
Verified in-browser: navigating `/guides/day-to-day/issues/` →
`/reference/api/issues/` swaps to exactly the server-rendered values, no
JS errors.
- **`scripts/verify-seo-metadata.mjs`** (new) enforces presence,
uniqueness, length, complete-sentence endings, and the
frontmatter-safety rules. Wired into `docs:test` and CI as its own step.
I negative-tested the gate rather than assuming it works — it correctly
fails on a duplicate title, a mid-word description, and a missing field,
and passes again once restored.
## Automating it going forward
`skills/sync-docs/SKILL.md` now:
- gains an **"Authored SEO metadata"** section: why the fields exist,
the enforced rules as a table, and how to actually write them (title
names the subject not the nav position; description writes for the
click; never generate mechanically from the first paragraph — *that is
the fallback the gate exists to prevent*).
- requires both fields in the **page-authoring instruction** given to
every subagent, with guidance on when to update an existing description
versus leave it.
- runs `docs:test:seo-metadata` and `docs:test:crawlable-links` as
**fail-loud gates in Phase 7** before commit.
- documents all six build gates in the files/gates section.
So once this lands, a new page cannot ship without hand-written
metadata, and a title collision cannot reach production.
## Verified
All six verifiers pass:
```
Static route verification passed
Asset fingerprint verification passed
Hierarchical Skills nav verification passed
Skill source block verification passed (11 skill pages, 1 control page)
Crawlable-link contract passed: 40886 internal links across 194 pages resolve in one hop
Authored-SEO contract passed: 192 pages carry a unique, hand-written seo_title and seo_description
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
|
||
|
Aron PrinsandClaude Opus 5
|
5fa6e1dcbf |
docs: render the simplified-english skill source block (#114)
Fixes the last red check on `main`. ## What was wrong `docs/reference/skills/optional/content/simplified-english.md` was left on the pre-#89 layout — parsed `### Skill frontmatter` bullets plus a `### Skill instructions` section — so it was the only per-skill page without an embedded `SKILL.md`. `docs:test:skill-source-blocks` has failed on it since release #95: ``` docs/reference/skills/optional/content/simplified-english.md: expected exactly one skill-source block, found 0 ``` ## The fix Replaces both legacy sections with the authoritative `SKILL.md` in a single ` ```markdown skill-source ` block, matching every other per-skill page. Source copied verbatim from `paperclipai/paperclip` at `9964b03`, path `packages/skills-catalog/catalog/optional/content/simplified-english/SKILL.md`. **No guidance changed** — the upstream file's content is identical to what the page already described in its parsed form, so this is purely a layout conversion. ## Bonus: duplicate H1 The old layout rendered two H1s — the page title, then the `SKILL.md`'s own `# Simplified English` under "Skill instructions". That's the same duplicate-H1 defect #87 fixed elsewhere, surviving on this one page. ``` BEFORE: h1=2 skill-download-blocks=0 AFTER: h1=1 skill-download-blocks=1 ``` ## Verified All five docs verifiers pass — the first fully green run: ``` Static route verification passed (5 representative routes + /guides/welcome/this-route-does-not-exist/, root and /paperclip-docs/ builds). Asset fingerprint verification passed (bundle app.9b5b423f039c.js, 1 bundle, headers checked). Hierarchical Skills nav verification passed. Crawlable-link contract passed: 40886 internal links across 194 pages resolve in one hop, the server-rendered sidebar covers all 192 manifest routes, and sitemap dates are not uniform. Skill source block verification passed (11 skill pages, 1 control page). ``` Note the verifier now covers **11** skill pages rather than 10 — this page previously fell out of the contract entirely. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 5
|
29beedeb6a |
seo: make the docs link graph crawlable (#113)
## Why Google has indexed effectively nothing on `docs.paperclip.ing`. Search Console over 3 months: **8 of 192 URLs** have ever drawn an impression, **681 of 975 impressions (70%) go to `/guides/agent-developer/comments-and-communication`** — a legacy URL that 301s and isn't in the sitemap. Strip that, the homepage, and the team's own `site:` queries, and the canonical docs corpus earned **~7 organic impressions in 90 days**. It isn't an eligibility problem. Pages are fetchable, self-canonical, `index, follow`, and identical under a Googlebot UA. It's the internal link graph. ## What was actually broken **1. Every relative markdown link 404'd.** Authors write `./glossary.md`, but pages are served from trailing-slash route directories, so links resolved one level too deep: ``` page: /guides/welcome/key-concepts/ href: ./glossary.md → /guides/welcome/key-concepts/glossary.md 404 ( /guides/welcome/glossary.md would be 200 ) ``` Crawled all 192 live pages: **all 742 unique `.md` targets return 404**. That's **1,283 of 1,306 in-body internal links — 98% — broken**, leaving **0.1 working in-body links per page**. It went unnoticed because `app.js:postProcessInternalLinks` repairs these at runtime. Crawlers index the pre-render. **2. The sidebar wasn't server-rendered.** Interior pages shipped `<div id="sb-sections"></div>`, filled by JS. So the raw HTML offered the logo, prev, next — and ~7 dead links. No link equity reached deep pages. Search Console classified 98% of crawling as refresh, 2% as discovery. Net effect: a crawler saw every page as a dead end that was 98% broken links. Crawl demand collapsed — 14 crawled of 184, 15% of crawl responses 404. ## Changes - **Rewrite markdown links to canonical routes at build time**, and fail the build on any link no nav page publishes. (Passed first run with zero unresolved — every link had a valid destination, just emitted in a 404ing form.) - **Server-render the sidebar and breadcrumb** into every interior route from the manifest `app.js` already uses. `app.js` detects `data-server-rendered` and keeps the DOM rather than re-rendering identical markup. The mobile drawer stays client-built — it's `inert`/`aria-hidden` until a JS toggle opens it, so rendering it duplicated 192 links/page (~41KB) for no crawl benefit. - **Intercept canonical route links in articles** so in-page navigation stays a soft transition instead of a full reload. - **Omit sitemap `<lastmod>` when git history is untrustworthy.** Reproduced the real mechanism: in a `--depth=1` clone, `git log -1` returns the single fetched commit's date for *every* file. Two files that differ locally (`2026-08-18` / `2026-07-08`) both come back `2026-08-25` shallow. That is exactly the live `192 × 2026-08-20`. Cloudflare Pages shallow-clones by default. - **Ship `redirects.json`** — `app.js` fetches it at boot and it 404'd. - **Canonicalise the footer's `/reference/api/overview`** link, which spent a 301 on all 193 pages. - **Add `scripts/verify-crawlable-links.mjs` + CI**, gating on raw `.md` hrefs, missing targets, redirecting targets, relative hrefs, an unrendered sidebar, and uniform sitemap dates. The last two were both caught by the new verifier on its first run. ## Result | | Before (production) | After (generated bundle) | |---|---|---| | Broken in-body links | 1,283 (98%) | **0** | | Working in-body links | 23 | **1,501** | | Crawlable nav links/page | 0 | **192** | | Distinct sitemap dates | 1 | **24** (0 on shallow CI) | `Crawlable-link contract passed: 41078 internal links across 194 pages resolve in one hop.` ## Verified Built and driven in a real browser at `localhost:4321`: - Raw HTML (crawler / no-JS view): 192 inline sidebar links, breadcrumb rendered, **0 local `.md` hrefs**, single H1. Remaining empty containers are JS-only UI (search modal, drawer, runtime status). - SPA intact, no reloads, no JS errors: in-article links, prev/next, sidebar links, mobile drawer (opens, 192 links, closes on navigate), search (8 results for "adapter"). Breadcrumb and active-link state follow correctly throughout. - Subpath build for gh-pages emits correct `/paperclip-docs/...` hrefs. - Homepage unchanged: 15 landing cards, 192 directory links. - Shallow-clone build confirmed to warn and emit zero `<lastmod>`. ## Notes for review - **This can't ship until the Cloudflare GitHub App is unsuspended.** Everything here is verified against a local build only. - **CI will be red on one pre-existing, unrelated failure**: `docs:test:skill-source-blocks` on `docs/reference/skills/optional/content/simplified-english.md` (missing its skill-source block, from release #95). Confirmed failing on clean `main`. Left in the aggregate rather than weakening the suite — fixing it needs the real `SKILL.md` from the parent repo, which is sync-docs work. - **Production will now ship no `lastmod` at all** on Cloudflare's shallow clone. Correct versus lying. To get real dates back, set the Pages build command to `git fetch --unshallow || true; npm run docs:build` — documented in the generated `DEPLOY.md`. - Page weight 67KB → 109KB from the inlined nav. Highly repetitive, compresses well, but it is a real increase. - Weak/duplicate titles were deliberately skipped, per the plan's own ranking (secondary). - Plan item 4 (contextual links from high-authority surfaces to 20–25 priority pages) is a `paperclip-website` change plus editorial judgment, so it's out of scope here. Worth noting that fixing the internal graph recovers most of what that item was meant to buy — the dominant authority failure was internal, not off-site. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 5
|
63e10a3cd6 |
sync-docs: require verifying the release is live before calling it shipped (#112)
## What happened Today's `v2026.824.0` release **did** write its docs-changelog entry. The accordion is on `main` in `docs/reference/changelog.md`, every one of the 15 pages the release touched is listed, and `npm run docs:build` renders it correctly with exactly one open accordion. What didn't happen is publication. `docs.paperclip.ing` is still serving the build from `ebbab07` (#100, the pre-release hotfix): | Check | Expected | Live | |---|---|---| | `/reference/deploy/tailscale-https-broker/` | `200` | `404` | | `paperclipai channels` on `/reference/cli/installation/` | present | absent | | top changelog entry | `v2026.824.0` | `v2026.817.0` | The `main`-branch Pages preview is stale in the same way, so neither commit pushed to `main` today (#110, #111) deployed. `npm run docs:build` succeeds from a clean checkout of `main`, so it isn't a build break — the Cloudflare Pages deploy simply never ran. ## Why the skill didn't catch it Phase 7 builds into `.site`, which is gitignored — nothing reader-facing is ever committed — and Phase 8 hands off at the merge. There was no step that looked at the live site. The runbook had a soft "Confirm `docs.paperclip.ing` is rebuilt successfully" bullet with no method and no fallback, and it was skipped along with its siblings: the `docs/v2026.824.0` tag was never cut (last one is `docs/v2026.707.0`), and `nightly`'s `.sync-state.json` still reads `branch_mode: "release"`. ## What this changes - **`skills/sync-docs/SKILL.md`** — new **Phase 9 — Publish & verify live** (release mode only): do every post-merge follow-up (tag, realign, flip `branch_mode`), verify production against three independent live signals, republish via `wrangler pages deploy` if stale, and report the status codes as evidence. Verification is mandatory even when pushing isn't approved. Plus a failure-mode row, a diagnosis-order special case, and a pointer from Phase 6.5 (the entry isn't done until it's live). - **`maintenance/runbook.md`** — replaces the soft "confirm" bullet with the actual checks and the manual republish fallback. - **`README.md`** — it claimed there is no Wrangler publish step for this repo; notes the auto-deploy isn't guaranteed and documents the fallback. No changelog content changed — the `v2026.824.0` entry needed no correction. Merging this PR pushes to `main`, which should also re-trigger the deploy that stalled. ## Verification - `npm run docs:build` — clean - `npm run sync:check` — lint-links and verify-nav pass; the 5 `rest-route-missing` drift candidates are pre-existing medium-confidence `Verify:` entries from the release, untouched here 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
8a858777f2 |
sync-docs: tag-accuracy gate + release-channel-aware skill (#111)
Makes /sync-docs correct under the canary→nightly→beta→stable channel model. Adds the release-mode tag-accuracy gate (scripts/sync/check-tag-accuracy.mjs) that verifies every changed page against the stable tag and flags post-tag leaks; stable-CalVer guard + channel glossary, tag-scoped drift/verify, and Phase 5.7 in the skill; realign fix that keeps nightly's drafts; a release-channels watcher; the analysis/plan doc; and a hermetic test (sync:test 38/38). Co-Authored-By: Claude Opus 4.8 <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
6c4519af4a |
Release docs for paperclip v2026.824.0 (#110)
Cumulative docs sync from v2026.817.0 to the v2026.824.0 stable tag. New/updated: Tailscale HTTPS broker, workspaces HTTPS exposure, release channels + `paperclipai channels`, resumable company import (guide + companies API), secret catalog, Claude setup-token login, adapter device-login, issue file-resource availability, document comments, interaction resolver-policy/governance. Version-stamped touched pages and added the v2026.824.0 docs-changelog entry. Verified every page against the v2026.824.0 tag; stripped post-tag master leaks (Kimi adapter, reaper-cooldown env var, mission-less onboarding rewrite) that nightly had drafted ahead of the release. Screenshots flagged (192 stale) but not recaptured this release. Co-Authored-By: Claude Opus 4.8 <[email protected]> |
||
|
|
ebbab07ca3 |
docs: correct decisions triage UI guidance (#100)
## Summary - describe the **When to decide** row as the primary triage path - keep the Decisions API as an additional path ## Verification - `npm run sync:lint-links` - `git diff --check` Co-authored-by: Dev Agent <[email protected]> Co-authored-by: Paperclip <[email protected]> |
||
|
Aron PrinsandClaude Opus 5
|
6e6990539c |
Add the v2026.817.0 docs changelog entry, and a step that writes it (#96)
The documentation changelog was never updated for v2026.817.0. This adds the missing entry, and closes the hole that let it go missing. ## Why it was missing `docs/reference/changelog.md` has **exactly one commit in its entire history** — `8c21935` (#73), which created the page on 2026-07-23 with the v2026.722.0 and v2026.720.0 entries written by hand. `skills/sync-docs/SKILL.md` contains zero occurrences of "changelog": release mode merges nightly → main, tags, and ships, but never writes that page. The timing is why nobody noticed: | | | |---|---| | 2026-07-23 08:10 | v2026.722.0 release merged (#72) | | 2026-07-23 11:47 | changelog page created (#73), already current | | 2026-08-18 10:43 | v2026.817.0 merged (#95) ← first release that had to append | The page was born ~3.5 hours after the previous release, so it was correct on arrival. v2026.817.0 is the first one it could have missed, and it did. The frontmatter was stale by the same marker (`paperclip_version: v2026.722.0`). ## What's here **The entry** — 8 new pages (Decisions API, Status Cards API and guide, Chat-Style Tasks, the `service` CLI, three catalog skills), the substantive rewrites grouped by what a reader gains, and a short block on the screenshot overhaul. Frontmatter bumped to `v2026.817.0`. **Phase 6.5 in the sync-docs skill** (release mode only) — writes this page from the manifest the run already holds. It pins down the details that are easy to get wrong on a monthly cadence: - the `<details class="accordion">` shape, newest first - **only the newest entry carries `open`** — miss this and the page renders with two expanded - links are relative to `docs/reference/` - exclude repo maintenance files (`docs/user-guides/screenshots/`, `SCREENSHOTS_*.md`) — they're in the repo, not in the docs - skip entirely in nightly mode, so an unreleased tag can't leak Phase 7's `sync:check` already validates relative links, so a typo in a future entry fails the run instead of shipping. ## Checks - `npm run docs:build` — clean, 191 pages - `npm run sync:lint-links` — no broken internal links - Rendered output verified: v2026.817.0 sits on top with **exactly one** open accordion 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5 <[email protected]> |
||
|
|
631a6a0c53 |
Release docs for paperclip v2026.817.0 (content + screenshot overhaul) (#95)
Ships the v2026.817.0 docs to live: the doc content that was authored and verified earlier, plus a full screenshot overhaul. The content half (`cdf81e2` and the nightly commits behind it) has already been reviewed. **The screenshots are the part that needs eyes** — `f24d734`, 342 PNGs. ## Screenshots Everything was recaptured against the release commit `213dabab4f8e1f3bb1803a2924c0fea1289fcd4c` (`upstream/candidate/release-2026.817.0`). The previous shots were 375 parent-commits stale (v2026.720.0), with 228 of 310 entries flagged pending. All 342 registry entries now carry that SHA. > ⚠️ Worth knowing: the release commit is **not** an ancestor of the parent's > `master`, and local `master` was four days *older* than it. Capturing against > `master` would have both missed release UI and leaked 93 post-tag commits' worth > of UI into the release docs. ### New coverage (34 entries) Three guides shipped with **no images at all** despite being 115–136 lines. They now have them: | Guide | Shots | |---|---| | `guides/day-to-day/decisions.md` | queue, an agent-proposed decision with its options, triage strip, filter panel, named queue, Decided curtain, empty state | | `experimental/status-cards.md` | board, New card dialog, and all four drawer tabs | | `experimental/task-chat.md` | thread, composer mode picker, side pane | | `reference/api/secrets.md` | the board-side Proposals tab | Chat-Style Tasks is captured in a **separate pass**: `enableTaskChatRedesign` is instance-wide, so leaving it on would have turned every classic issue/task/work-mode shot into the redesigned chat. ## Two defects that were already live Both were shipping in the docs before this PR: 1. **`issues/detail-chat.png` and the `tasks/*` shots were mostly plugin debug output.** The Kitchen Sink example plugin mounts a panel into the issue page that dumps the raw issue JSON, and the seed installed it. Those guides were illustrating a debug panel instead of the task page. The seed no longer installs it. 2. **The seeded task thread was a monologue** — four board-user messages in a row, because the board actor cannot post agent comments. It is now a real two-sided exchange. ## Targets repointed because the UI moved | Target | Why | |---|---| | `activity/*` | `Activity.tsx` deleted; `/activity` renders `pages/audit/CompanyActivity.tsx` | | `experimental/cloud-upstream` | `CloudUpstream.tsx` deleted; the route now redirects to `/company/export` | | `settings/*`, `plugins/*`, `adapters/*` | `/instance/settings/*` are legacy redirects now | | `dashboard/stale-tasks-panel` | panel removed from `Dashboard.tsx` — target dropped | Plus eight targets with **silent selector drift**. A failed interaction step falls back to "whatever state was reached", so these had been quietly producing wrong images — a plain inbox where the doc promised a mode picker, a whole dashboard where it promised one panel. Full table in `docs/user-guides/screenshots/SCREENSHOTS_PLAN_v2026.817.0.md` §C2. ## Pipeline Decisions, status-card summaries and secret proposals are all **agent-authored**, and the board actor the seed runs as is refused by every one of them (`"Agent run context required"`, `"Secret proposals require a verified run-bound agent token"`). Rather than insert rows behind the API, `seed-new-surfaces.mjs` borrows the two doors a real run already has — a board-minted agent API key, and a locally signed agent JWT — so every write goes through the production code path. Also: - `capture.mjs` records a real `captured_against` on a detached checkout instead of the literal string `"HEAD"` (which is what every pre-2026.817 entry recorded), and gains a `scrollTo` step for content below the fold. - `run.mjs` gains `--serve` for iterating on the seed, the task-chat phase, and a keeper that holds the demo board's issue statuses steady — the demo `process` agents finish runs without declaring a disposition, so the stalled-work sweep re-blocks issues every few minutes over a capture that runs far longer. ## Reviewing Light and dark both captured at 1440×900 @2x. The new surfaces are the ones to scrutinise; the rest is a like-for-like refresh. ### One leftover Dropping `dashboard/stale-tasks-panel` leaves `{light,dark}/dashboard/stale-tasks-panel.png` tracked but unused — they need deleting by hand. 🤖 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]> |
||
|
DottaandDevRel Gemini
|
1f6b9f3846 |
docs: redirect legacy what-is-paperclip URL (#93)
## Thinking Path > - Paperclip uses a public documentation site to help users learn the product. > - The site build reads legacy routes from `site/redirects.json`. > - Two old `/start/` routes redirect to current guide pages. > - The old `/start/what-is-paperclip` route has no matching redirect. > - Search engines still send users to that old route. > - This pull request adds the missing redirect entry. > - The benefit is a working 301 response for both slash variants. ## Linked Issues or Issue Description **Issue type** Outdated documentation route. **Where is the issue?** `https://docs.paperclip.ing/start/what-is-paperclip` **What's wrong?** The legacy URL returns a hard 404. The live replacement is `/guides/welcome/what-is-paperclip/`. **Suggested fix** Add the proven legacy path to `site/redirects.json`. Do not add speculative `/start/` redirects. ## What Changed - Added `start/what-is-paperclip` to the legacy redirect map. - Kept the existing `start/quickstart` and `start/core-concepts` mappings unchanged. ## Verification - Ran `npm run docs:test:static-routes` successfully. - Ran `npm run docs:build` successfully. - Confirmed the generated `_redirects` file contains 301 rules for both `/start/what-is-paperclip` variants. - Confirmed the generated sibling rules remain present. ## Risks - Low risk. The change adds one redirect map entry and does not change page content or route generation logic. ## Model Used - OpenAI `gpt-5.4` through Codex CLI, with reasoning, tool use, and code execution. The runtime does not expose the context window size. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change and contains no internal ticket ID - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All configured CI gates are green - [x] No Greptile check is configured for this repository, and no Greptile comments are open - [x] I will address all Greptile and reviewer comments before requesting merge Co-authored-by: DevRel Gemini <[email protected]> |
||
|
|
c7b3f4cacf |
Render full SKILL.md as a code snippet on per-skill pages (PAP-16980) (#89)
> **Updated on current main:** #87 and the #90 cache hotfix are merged. This PR now targets `main`, was rebased onto merge commit `8c5976f`, and has a fresh successful Cloudflare preview plus post-rebase browser smoke evidence. ## What & why (PAP-16980) Improves SEO/AEO on the bundled/optional **per-skill reference pages** (from PAP-16670) by clearly separating the *human-readable catalog summary* (top of page) from the *authoritative full skill definition*. Previously the "Full skill definition" section rendered the `SKILL.md` as **parsed Markdown**, so each skill's own `##` headings, lists, and fenced examples became real page content — competing with the summary, inflating the on-page TOC (e.g. qa-acceptance went from **16 → 6** "On this page" entries), and confusing crawlers/answer engines about the page's true structure. Now each per-skill page shows the **complete, verbatim `SKILL.md`** (frontmatter + body) inline, rendered through the **existing production code-snippet treatment**. ## Changes - **Content (10 per-skill pages):** replaced the old `### Skill frontmatter` bullets + parsed `### Skill instructions` layout with the full `SKILL.md` embedded in a fenced ````markdown skill-source` block. Source bytes were taken verbatim from each skill's authoritative `SKILL.md` at the page's pinned `paperclip_version`, verified against the page's own prior instructions body + frontmatter (name/description) so no content drifted. - **Renderers (`site/build-release.mjs`, `site/app.js`):** a `skill-source` fence renders as `<pre><code class="language-markdown" data-skill-download="SKILL.md">`. Every other code block is delegated to marked's default renderer, so existing snippets are byte-for-byte unchanged. Rendered identically in the crawler-visible build HTML and on client SPA navigation. - **Copy + Download (`site/app.js`, `site/styles.css`):** `decorateCodeBlocks` reuses the existing Copy affordance and adds a **Download `SKILL.md`** control beside it. Both share dimensions, styling, hover/focus visibility, and the copied-success state; both carry accessible labels/titles. - **Readable full-source wrapping (`site/styles.css`):** only the downloadable `SKILL.md` block uses `white-space: pre-wrap` and safe long-token wrapping. Ordinary code snippets retain the existing horizontal-scroll treatment. - **Test:** `scripts/verify-skill-source-blocks.mjs` (`npm run docs:test:skill-source-blocks`) asserts the render contract (single H1, single `<pre>`, frontmatter present, no legacy headings) and that ordinary docs pages emit no `data-skill-download`. ## Scope statement No catalog-page layout, navigation, typography, summary-copy, metadata-card, or information-architecture changes. `paperclip-website` and generated `.site/` output are untouched. `optional/finance/ramp.md` is intentionally excluded — it is a newer summary page with no embedded full-definition section to reformat. The diff is the 10 skill pages + the narrow renderer/Copy-Download support + the test. ## Evidence **1–2. Before/after (desktop, 1280×900) + mobile after (390×844)** — attached to Paperclip issue [PAP-16980](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/3098577a-4f6f-4eb2-9151-a4b61917dffd) (`before-desktop.png`, `after-desktop-controls.png`, `after-controls-zoom.png`, `after-mobile.png`). GitHub cannot render the auth-gated attachment URLs inline, so they live on the issue for reviewers. **4. Raw DOM/HTML (build output, qa-acceptance):** - Article renders exactly **one H1**: `<h1 id="qa-acceptance">QA Acceptance</h1>` - Full source inside a single code block: ```html <pre><code class="language-markdown" data-skill-download="SKILL.md">--- name: qa-acceptance description: Produce QA acceptance criteria and a manual validation plan … key: paperclipai/bundled/quality/qa-acceptance recommendedForRoles: - qa … </code></pre> ``` - Article `<pre>` count: **1** (inner ````` fences stay literal — no breakout). 10/10 skill pages carry the block; 0 non-skill pages do. **5. Copy + Download behavior (Playwright against the built site):** ```json { "downloadFilename": "SKILL.md", "downloadMatchesBlock": true, // downloaded file === code block text, byte-identical "downloadBytes": 3853, "copyShowsSuccess": true, // Copy toggles the existing is-copied success state "accessibleLabels": { "copy": "Copy code", "download": "Download SKILL.md" } } ``` Both controls reach `opacity: 1` on `.code-wrap:hover` and on keyboard `:focus-visible` (verified `matches(':focus-visible') === true` → computed opacity `1`). **H1 audit (every generated route, incl. all skill URLs — requested on the issue):** built the site on current `main` and scanned **all 184 generated `index.html` routes** (16 skill routes among them). **Every route has exactly one `<h1>`.** The skill source's own `#`/`##` headings live *inside* the `<pre><code>` block as literal text, so they do **not** create competing H1s — the SEO/AEO goal. ## Tests Run against current `main` after #87 and #90: ``` docs:build ............................. ok (184 routes) docs:test:static-routes ................ pass (5 routes + 404 + root + subpath) docs:test:skill-source-blocks .......... pass (10 skill pages, 1 control page) H1 audit (all 184 routes) .............. pass (exactly 1 h1 each; 16 skill routes) ``` **Do not merge/deploy** — returning to Dotta/reviewers for approval per PAP-16980. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> |
||
|
|
8c5976ffd3 |
URGENT: fingerprint docs client bundle to fix mixed-version cache regression (PAP-16990) (#90)
## Urgent hotfix — mixed-version asset cache regression (PAP-16990) Restores reliable navigation on https://docs.paperclip.ing/ without undoing the PAP-16670/#87 server-render + single-H1 SEO/AEO work. ### Root cause The server-render change shipped new HTML that removed `#loading` / `#error-state`, but every generated route still loaded the client bundle from a **stable URL**: `<script src="app.js" defer>`. Cloudflare/browsers cache `/app.js` for up to ~4h independently of the HTML, so a returning visitor could pair freshly-revalidated new HTML with a **pre-merge cached `app.js`**. The old click path looked for the removed elements, threw before render, hid the homepage, and left a blank `#main` (no URL update). Forced refresh recovered — not acceptable. CSS was never part of this: it is inlined into every page and travels with the (revalidating) HTML. `content.json` is byte-identical prod↔preview. ### Fix (narrow cache-bust, no rollback) 1. **Content-fingerprint the client bundle.** Emit `app.<hash>.js` (+ `styles.<hash>.css`) and rewrite the shell so *every* route references the exact build's asset URL. A changed bundle gets a brand-new URL no cache can satisfy with stale bytes — closes the mixed-version window in **both** directions. No unversioned `/app.js` is emitted, so a stale cache has nothing to pin. 2. **`_headers`:** fingerprinted JS/CSS cached `immutable` (1y); HTML routes (`/`, `/*/`) and `content.json` set `max-age=0, must-revalidate`. 3. `inlineReleaseStyles` now matches the fingerprinted stylesheet link so CSS stays inlined. ### Before / after ``` - <script src="app.js" defer></script> # stable URL — cacheable across versions + <script src="app.1b669c8d0aec.js" defer></script> # content-hash URL — cache miss on any change ``` `_headers` (new): ``` /app.*.js Cache-Control: public, max-age=31536000, immutable / /*/ Cache-Control: public, max-age=0, must-revalidate /content.json Cache-Control: public, max-age=0, must-revalidate ``` ### Verification (local build, base path `/`) - `npm run docs:build` → emits `app.1b669c8d0aec.js`, `styles.9e3f24983c72.css`; **184/185** HTML files reference the fingerprinted bundle (185th is the scriptless `404.html`); **no** bare `app.js`/`styles.css` file or reference remains. - `npm run docs:test:asset-fingerprints` ✅ (new) — proves the URL is the content hash of the served bytes, changes on any content change, is referenced identically by root + interior routes, has no unversioned sibling, and the cache headers are present. - `npm run docs:test:static-routes` ✅ — single-H1 interior pages, no-JS server-render, homepage manifest completeness, 404 separation, root + `/paperclip-docs/` builds. ### Remaining (post-merge, needs a real browser on the live domain) Chromium can't launch in the CI/agent sandbox (missing system libs), so **cold + returning/cached** browser smoke on https://docs.paperclip.ing/ must be run after merge → redeploy from `main`. Checklist: cold load, homepage-card nav (URL updates, one H1, no blank), interior↔interior, Back/Forward, All Docs, search, 404, and a returning/cached session (prior `/app.js` in cache). Does **not** touch the SKILL.md formatting PR (PAP-16980), per the issue. Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Claude Opus 4.8 <[email protected]> |
||
|
|
e2adb1c167 |
PR1 — server-render the docs root and split it from interior routes (Phase 1) [DO NOT MERGE] (#87)
# PR1 — server-render the docs root and split it from interior routes (Phase 1) **Do not merge — Dotta alone may merge.** This PR is opened for review only, per the hard write-gate on the approved plan. ## Provenance | item | link | |---|---| | Accepted plan | [PAP-16672 · plan document](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/PAP-16672#document-plan) | | Phase 0 review packet | [PAP-16671 · packet comment](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/PAP-16671#comment-f653273d-6450-4f8d-bcd6-f805ad28b923) | | Implementation candidate | [PAP-16682](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/PAP-16682) | | Independent QA — **PASS** | [PAP-16683](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/PAP-16683) | | Finalization / this PR | [PAP-16684](https://paperclip-dev.tail29c1aa.ts.net/PAP/issues/PAP-16684) | | Full evidence gallery (screenshots + raw JSON probes) | https://pages.paperclip.ing/pap-16684-pr1-evidence/ | Base: approved `main` @ `2ab76e8e4`. Head: `f5bbba24c` (exactly one commit on top; `main` has not moved). ## What changed - **1.1 — root-only landing shell.** The hero is *physically absent* from interior documents (removed at build time, not CSS/JS/ARIA hidden); the build throws if removal fails. Header, footer, search, sidebar, breadcrumbs and article nav are preserved on every page. - **1.2 — server-rendered homepage directory** generated from the same canonical `site/content.json` manifest that already feeds the sidebar, breadcrumbs, prev/next, routes and sitemap. No second URL manifest was introduced. - **Single descriptive H1 per interior page** (was 2 — the hero H1 bled onto every route). - **Truthful runtime UI.** `Loading…` / `Could not load this guide.` no longer ship inside success HTML; they are produced only by `app.js` at runtime on the empty, `hidden` `#runtime-status` mount, so they can only appear during a genuine client transition or failure. ``` scripts/verify-static-routes.mjs | 200 +++++++++++++++++++++++++++++++++- site/app.js | 90 ++++++++++++---- site/build-release.mjs | 189 ++++++++++++++++++++++++++++++-- site/index.html | 17 ++-- site/styles.css | 70 ++++++++++- 5 files changed, 528 insertions(+), 38 deletions(-) ``` `.site/` is **generated build output and remains uncommitted** (gitignored): `git ls-files | grep '^\.site/'` → 0 files. ## Before → after, raw HTTP/HTML for the six representative routes Both trees built with the identical command and base path, then served by a production-equivalent static server (real 404 status, honors `_redirects`). "Before" is a real build of approved `main` @ `2ab76e8e4`. | route | HTTP | content type | H1 count before → **after** | H1 text (after) | `id="landing"` before → after | `Loading…` | `Could not load this guide.` | internal directory anchors | |---|---|---|---|---|---|---|---|---| | `/` | 200 | `text/html` | 1 → **1** | Everything you need to run Paperclip. | 1 → 1 (root-only ✓) | 1 → **0** | 1 → **0** | 4 → **184** | | `/guides/welcome/what-is-paperclip/` | 200 | `text/html` | 2 → **1** | What is Paperclip? | 1 → **0** | 1 → **0** | 1 → **0** | 4 → 4 | | `/reference/api/overview/` | 200 | `text/html` | 2 → **1** | API Overview | 1 → **0** | 1 → **0** | 1 → **0** | 4 → 4 | | `/how-to/add-mcp-server-to-agent/` | 200 | `text/html` | 2 → **1** | Add an MCP server to an agent's toolkit | 1 → **0** | 1 → **0** | 1 → **0** | 4 → 4 | | `/reference/changelog/` | 200 | `text/html` | 2 → **1** | Documentation Changelog | 1 → **0** | 1 → **0** | 1 → **0** | 4 → 4 | | `/guides/welcome/this-route-does-not-exist/` | **404** | `text/html; charset=utf-8` | 1 → **1** | Not found | 0 → 0 | 0 → 0 | 0 → 0 | 0 → 0 | Machine-readable probes: [before-raw.json](https://pages.paperclip.ing/pap-16684-pr1-evidence/before-raw.json) · [after-raw.json](https://pages.paperclip.ing/pap-16684-pr1-evidence/after-raw.json). ### Homepage bleed and false state — absence proof - `id="landing"` returns **zero** matches in every interior document. Only inlined `#landing-*` **CSS selector text** remains (stylesheet, not markup). - Interiors carry no directory manifest (4 internal anchors — the footer); the 184-anchor directory is root-only. - The two false-state phrases appear in **0** built HTML files across the whole bundle. ### 404 / noindex / sitemap - Real HTTP **404** for the nonexistent route (root base and `/paperclip-docs/` subpath build). - `404.html`: exactly one `<h1>Not found</h1>`, `<meta name="robots" content="noindex, nofollow">`, `<title>Not found | Paperclip Docs</title>`. - Absent from `sitemap.xml` (0 occurrences); no built file for the route. - `sitemap.xml` has 184 `<loc>` (183 routes + root) and the root directory anchor set covers **183/183** non-root sitemap routes — 0 missing. - `_redirects` contains **no wildcard `200` rewrite** (0 lines with a `200` status), so unknown routes cannot be masked as success. - `robots.txt`: `User-agent: * / Allow: /` + `Sitemap: https://docs.paperclip.ing/sitemap.xml`. ## Focused checks — rerun on the final revision (`f5bbba24c`) | command | result | |---|---| | `npm run docs:test:static-routes` | **PASS** — "Static route verification passed (5 representative routes + /guides/welcome/this-route-does-not-exist/, root and /paperclip-docs/ builds)." | | `npm run docs:build` | **PASS** — "Generated 183 crawlable route pages plus sitemap.xml and robots.txt." | `git status` is clean after the build (no generated output enters the tree). ## Browser matrix — desktop 1440×900 and mobile 390×844 Run with Playwright + Chromium 1228. The QA sandbox could not exercise this (blank-glyph text rendering); the root cause turned out to be that **no fonts are installed on the host at all** — installing DejaVu TTFs with a minimal fontconfig makes text render correctly, which unblocked the full interactive matrix here. Screenshots: https://pages.paperclip.ing/pap-16684-pr1-evidence/ ### Per-route, JavaScript enabled (both viewports) All six routes on both viewports: expected HTTP status, **exactly 1 `<h1>`** with the correct text, `#landing` present **only** on `/`, no `Loading`/`Could not load this guide.` text in the rendered body, `#runtime-status` hidden, **no horizontal overflow**. ### Interactive | check | result | |---|---| | root directory link → interior (client nav) | ✅ `/guides/welcome/what-is-paperclip/`, single H1 "What is Paperclip?", hero gone, not stuck loading | | direct load vs client-nav parity | ✅ identical H1 set | | back / forward history | ✅ back → `/` with hero restored; forward → interior with correct H1 | | home nav from an interior doc | ✅ `/` with hero | | theme toggle | ✅ toggles (`dark` → light) | | desktop sidebar / TOC / breadcrumbs / prev-next / search / footer | ✅ 191 sidebar links, 14 TOC links, breadcrumbs rendered, article nav present, search control present, 15 footer links | | mobile drawer | ✅ opens (screenshot `mobile-drawer-open.png`) | | mobile horizontal scroll | ✅ none | | unknown route | ✅ 404 page, single H1, noindex | ### JavaScript disabled | check | result | |---|---| | `/` directory usable with JS off | ✅ 202 anchors present in raw markup; hero + card directory fully rendered | | clicking a directory link with JS off | ✅ full page load to `/reference/api/overview/` | | that interior page with JS off | ✅ 1 H1 ("API Overview"), no hero, no false loading/error state, 6368 chars of real article text | | mobile with JS off | ✅ root and interior both render correctly | ### Console / network No JavaScript errors and no page errors on any route. Exactly two non-2xx requests, **both reproduced identically on approved `main` @ `2ab76e8e4`** — neither is introduced by this PR: - `GET /redirects.json` → 404. Pre-existing: neither the before nor after build emits this file. Verified byte-for-byte identical behaviour on `main`. - `GET https://api.github.com/repos/paperclipai/paperclip` → 403. Unauthenticated GitHub API rate limit for the header star counter; environmental, external, not a product defect. Also confirmed unchanged before → after on the same interior page: header (1), footer (1), search controls (4), sidebar links (191), TOC links (14), article nav (2), article text length (4328 chars). The **only** rendered difference is the intended H1 2 → 1 and the removed hero. ## Verified against the real Cloudflare Pages deploy, not just a local server The Cloudflare Pages check on this PR is **green** and produced a live preview: **https://pap-16682-server-render-root.paperclip-docs-74t.pages.dev** I reran the entire matrix against that real deploy. Every invariant reproduces **identically** to the local run — so these results hold on actual production hosting, including Cloudflare's own 404 handling: | route | HTTP | H1 | `#landing` | `Loading…` | `Could not load…` | noindex | anchors | |---|---|---|---|---|---|---|---| | `/` | 200 | 1 — Everything you need to run Paperclip. | present (root-only) | 0 | 0 | – | 184 | | `/guides/welcome/what-is-paperclip/` | 200 | 1 — What is Paperclip? | absent | 0 | 0 | – | 4 | | `/reference/api/overview/` | 200 | 1 — API Overview | absent | 0 | 0 | – | 4 | | `/how-to/add-mcp-server-to-agent/` | 200 | 1 — Add an MCP server to an agent's toolkit | absent | 0 | 0 | – | 4 | | `/reference/changelog/` | 200 | 1 — Documentation Changelog | absent | 0 | 0 | – | 4 | | nonexistent route | **404** | 1 — Not found | absent | 0 | 0 | **yes** | 0 | Browser matrix on the live preview, desktop 1440×900 and mobile 390×844: identical outcomes — client nav, direct-load parity, back/forward, home-nav, theme toggle, 191 sidebar links, 14 TOC links, mobile drawer opens, no horizontal scroll, and with **JavaScript disabled** the root directory (202 anchors) navigates by real page load into an interior with 1 H1, no hero, no false state and 6368 chars of article text. **Console/network on the live deploy: zero page errors.** The same two known non-product requests appear (`/redirects.json` and the GitHub star-count API). `/redirects.json` returns **404 on live production `docs.paperclip.ing` today** and on the `main` branch preview — conclusively pre-existing and unrelated to this PR. Screenshots from both the Cloudflare deploy and the local server are in the gallery: https://pages.paperclip.ing/pap-16684-pr1-evidence/ ## Out of scope — pre-existing observation, not a regression On the `--base-path /paperclip-docs/` subpath build, 4 footer links (`/reference/api/overview`, `/guides/org/agents/`, `/guides/org/adapters/`, `/guides/getting-started/five-minute-path/`) are emitted un-prefixed. Building approved `main` @ `2ab76e8e4` with the identical flag reproduces **exactly the same 4 links**, so this is a pre-existing footer-template issue untouched by this PR. Smallest fix would be routing the footer's hardcoded hrefs through the base-path prefixer, in a separate ticket. ## Merge policy `.site/` is generated output and is intentionally uncommitted. **This PR must remain open and unmerged — Dotta alone may merge it.** Co-authored-by: ClaudeCoder <[email protected]> Co-authored-by: Claude Opus 5 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
2ab76e8e4b |
docs: fix goals reparenting, human-invite signup, macOS install, first-company step (#80)
Addresses open documentation-feedback issues, each verified against the `paperclipai/paperclip` source. ## Changes - **Goals — reparenting (#13):** The goal properties panel renders the parent goal as a read-only link (unlike issues, which have an editable parent picker), and the goal update mutation never sends `parentId`. The docs claimed you could "change the parent field" in the panel. Corrected to describe the real path — `paperclipai goal update <id> --parent-id <id|null>` / `PATCH /goals/{id}` — and removed "parent" from the list of panel-editable fields. - **Add a human teammate — signup (#50):** The reported "Email and password sign up is not enabled" is thrown by Better Auth when `emailAndPassword.disableSignUp` is set, which Paperclip wires from `auth.disableSignUp` / `PAPERCLIP_AUTH_DISABLE_SIGN_UP`. Added a troubleshooting callout naming the cause and how to re-enable self-service signup. - **Installation — macOS Apple Silicon (#74):** The Terminal install path had no troubleshooting section. Added a note for the embedded PostgreSQL start failure caused by missing `libzstd`/`liblz4` compatibility symlinks, with a copy-paste fix. - **Create your first company (#16):** Renamed the step 4 heading from "Save and continue" to "Create the company" to match the actual **Create Company** button. ## Verification - `sync:lint-links` passes — 186 markdown files, no broken internal links. - Product-behaviour claims (#13, #50) confirmed directly in parent source; #74 documents the reporter's symptom (doc-gap confirmed, not independently reproduced). Closes #13, #16, #50, #74 Co-authored-by: Claude Opus 4.8 <[email protected]> |
||
|
Michael Nguyenandanicca
|
f80e8a7289 |
Make docs navigation crawlable and sitemap dates accurate (#77)
## Summary - emit previous and next article navigation as real anchors in generated HTML - preserve the existing client-side navigation behavior - derive sitemap lastmod values from each Markdown file's Git history - omit lastmod when history is unavailable instead of publishing the build date - remove ignored changefreq and priority values - add regression assertions for crawlable links and sitemap dates ## Verification - npm run docs:test:static-routes - npm run sync:lint-links - npm run docs:build - generated 183 pages with zero server-rendered orphans, minimum one inbound link, and 23 distinct lastmod dates - git diff --check ## Risk Low. No routes, redirect rules, canonicals, robots directives, or index/noindex policy changed. Production still requires merge through the existing workflow. Co-authored-by: anicca <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
8c21935aa6 |
Add documentation changelog page with reusable accordion (#73)
## What Adds a **Changelog** category (Reference tier) with a **Docs** page that tracks what changed in *these docs* — pages added, rewritten, or expanded — per release. It's framed as a changelog for the documentation itself, not a mirror of Paperclip's product release notes (which it links out to). Backfilled with the full documentation history: **10 releases** from `v2026.513.0` (this repo's genesis) through `v2026.722.0`, reconstructed from each release commit's own docs summary. Each release is a collapsible accordion; the newest stays open. ## New design-system component Introduces a reusable native `<details>`/`<summary>` **accordion** (no JS): - `site/styles.css` — `details.accordion` styled with existing tokens (border/radius, parchment hover, rotating chevron, theme-aware), with an optional `.accordion-meta` right-aligned label. - `site/app.js` — allowlists `DETAILS`/`SUMMARY` + the `open` attribute in the client-side markdown sanitizer so collapsible content survives SPA rendering. Usage: ```html <details class="accordion" open> <summary>Title <span class="accordion-meta">meta</span></summary> <div class="accordion-body"> Markdown content — keep the blank lines so it parses. </div> </details> ``` ## Files - `docs/reference/changelog.md` (new) - `site/content.json` — Changelog category / Docs page nav entry - `site/styles.css`, `site/app.js` — accordion component ## Verification - `npm run sync:lint-links` — clean, no broken internal links (links verified against current tree; renamed/retired pages point at live targets). - `npm run sync:verify-nav` — passes (only orphans are the intentional CLI redirect pages). - `npm run docs:build` — all 10 accordions render, `/reference/changelog/` route builds. ## Note This is a **manual** changelog for now. A follow-up could hook a "prepend a new accordion" step into the `/sync-docs` release phase so future releases self-populate. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 <[email protected]> |
||
|
|
44e12ab37c |
Release docs for paperclip v2026.722.0 (#72)
Release docs for **paperclip v2026.722.0** (window `v2026.720.0 → v2026.722.0`; 256 changed parent files, 60 commits, diff window clean — 0 truncated leaves). Nothing here goes live until this PR is merged to `main`. ## Surfaces authored this run | Surface | Docs | Parent PR | |---|---|---| | **Run-bound agent secret access** — `access.`-prefixed / `api` delivery mode; `GET /api/agents/me/secrets`, `POST /api/agents/me/secrets/:key/value` (`Cache-Control: no-store`) | `api/secrets.md`, `api/agents.md` | #9921 | | **Local agents run natively on Windows** (ACPX, no Bash wrapper; env via session options; `.cmd` shim; symlink→copy on EPERM) | `adapters/acpx-local.md` | #9980 | | **`PAPERCLIP_*` bindings flow through**; only `PAPERCLIP_API_KEY` rejected (override removed); `DO_NOT_TRACK` / `PAPERCLIP_TELEMETRY_DISABLED` opt-out | `deploy/environment-variables.md` | #9974, #9946, #9906 | | **Safer `CODEX_HOME` sandbox sync** — explicit allowlist, not whole home | `adapters/codex.md` | #9972 | | **Plugin SDK** environment-sync exports + `onEnvironmentSyncIn/Out` hooks | `reference/plugins/sdk.md` | — | | **CLI `company export --force`** | `reference/cli/company.md` | — | | **Connections v3 (Apps)** experimental foundation — `remote_http`→`mcp_remote`, `connection_grants`, AppDefinition catalog | `experimental/connections-apps.md` (new) | #9958, #9981, #9982 | Riding along from earlier nightly drafts (part of this release): secret folders (`administration/secret-folders.md`), searchable agent picker, cloud-managed bootstrap gate (`api/instance-admin.md`). ## Verification All authored claims verified against parent code at tag `v2026.722.0` (`verify-edit`): **0 high-confidence unverified**. `docs:build`, `sync:lint-links`, and `sync:verify-nav` all pass. Frontmatter stamped `paperclip_version: v2026.722.0`. The 2 nav orphans (`cli/commands.md`, `cli/control-plane-commands.md`) are the intentional redirect anchors. ### ⚠ Drift (all resolved as false positives — no action) `sync:check-drift` flagged 4 `rest-route-missing` candidates: - `GET /api/agents/me/secrets` and `POST /api/agents/me/secrets/{key}/value` (in `api/agents.md` and `api/secrets.md`). These are the **new** routes this PR documents. The flags fire because the drift checker searched a stale `last_seen` sha and REST-route matching is medium-confidence (router-prefix registration hides the literal). Both routes were verified verbatim against `server/src/routes/secrets.ts` at tag `v2026.722.0`. No change needed. One `verify-edit` env-var flag (`PAPERCLIP_CLOUD_PROD_PROVIDER_RAILWAY_TOKEN`) is the release-note **illustrative example** of a user-chosen name, framed in prose as "for example a secret called …" — not a real product variable. No change needed. ### ↻ Renames detected None. ### ⚠ Reconcile None. ## Screenshots See `SCREENSHOTS_PENDING.md`. 13 unique captures (×2 light/dark) are genuinely stale — mainly agent-config surfaces (`AgentConfigForm.tsx` gained the Secret access editor) and secrets. Net-zero `+0/-0` UI touches were filtered out. Not auto-captured — recapture via `npm run screenshots:refresh` goes to a separate review PR. The new `secret-folders.md` and `connections-apps.md` pages have no captures yet. ## Post-merge (squash-only repo) After squash-merging, run `node scripts/sync/realign-nightly.mjs release/v2026.722.0 --push` and bump `.sync-state.json` `base_release_tag` to `v2026.722.0`. Skipping the realign arms the add/add-conflict trap at the next nightly run. 🤖 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]> |
||
|
|
175648e771 |
docs: add Experimental feature section and screenshots (#71)
## Summary - adds a new **Experimental** documentation section with an overview and 10 feature pages covering motivation, enablement, usage, and caveats - wires the section into `site/content.json` and refreshes the experimental flag list in administration settings - adds six screenshot capture targets and 12 QA-verified screenshots (light and dark) for experimental feature surfaces - includes the screenshot-pipeline fixes needed to seed and capture those surfaces reliably ## Screenshots Adds light and dark captures for: - environments - cloud upstream - file viewer - external objects - server info - recovery preview The 12 PNGs were verified on Paperclip task PAP-14814 on July 21, 2026 and were preserved byte-for-byte during the rebase. ## Verification - `npm run sync:lint-links` — pass; no broken internal links - `npm run sync:verify-nav` — pass; only the two pre-existing CLI orphans - `npm run sync:verify-screenshots` — pass; every documented screenshot is tracked and indexed - `npm run docs:build` — pass Paperclip: PAP-14705 --------- Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> Co-authored-by: Claude Fable 5 <[email protected]> |
||
|
Aron PrinsandClaude Fable 5
|
5fdce2b098 |
screenshots: pre-seed capture phase for onboarding-wizard shots (#70)
Fixes the harness limitation flagged in #68: the seeded instance always has a company, so the create-a-company wizard was unreachable and onboarding shots fell back to the Dashboard. **How:** `run.mjs` gains a phase 3.5 — after health check, before seeding — that captures targets marked `phase: "pre-seed"` while the instance is still company-less (`/onboarding` serves the wizard there). `capture.mjs` gains a `phase` option (`--phase`); post-seed stays the default, so existing invocations are unchanged. **Retargeted:** the four true wizard shots to `/onboarding` (goal-field fills the company name and advances to the Mission step); the two budget shots to the agent configuration form, since the wizard has no budget UI (verified at v2026.720.0). **Validated with real runs against the v2026.720.0 tag** — all pre-seed captures succeed with zero step failures, light and dark visually verified (wizard step 1 empty, filled name, Mission step). Refreshed PNGs included. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Fable 5 <[email protected]> |
||
|
Aron PrinsandClaude Fable 5
|
215dc2ed2d |
screenshots: wire routes for 20 unrouted registry entries (#69)
Backfills `route` + `dependsOn` for the 20 registry entries flagged in #68 as never wired for automated capture (plus marks the hand-annotated `dashboard-overview-annotated` as intentionally manual instead of leaving its stale `_todo`). Routes verified against the v2026.720.0 route table in `ui/src/App.tsx`; every `dependsOn` path verified to exist at that tag. Details and caveats (dialog-step captures, the onboarding harness limitation) in the commit message. No images change in this PR — next capture pass picks these up. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Fable 5 <[email protected]> |
||
|
Aron PrinsandClaude Fable 5
|
ef28814c68 |
Screenshot overhaul for paperclip v2026.720.0 (#68)
Full screenshot overhaul for **paperclip v2026.720.0** — the design-system convergence in this release (single-source tokens, retuned theme, Card/Badge adoption, radius ladder, Lucide status glyphs) invalidated 248 of 298 registry entries, so this recaptures everything with a route rather than a targeted refresh. Captured with `npm run screenshots:refresh:all` against parent tag `v2026.720.0` (`903bd157c`), on the standard isolated seeded instance (loopback :3197, embedded Postgres on a free port). 1440×900 @2x, light + dark. ## What's in here - **246 recaptured PNGs** (123 logical shots × light + dark), all stamped `captured_sha: 903bd157c…` in `registry.json`. - Dimensions, theme correctness, and file sanity verified by an automated review pass: all full-page captures 2880×1800, dark variants genuinely dark, no blank/error/login pages, no 0-byte files. The two intentionally small cropped stat-panel shots are correct. ## Excluded after review (kept on their old captures, still marked stale) Five logical captures came out showing the **wrong UI state** and were reverted rather than shipped: | Capture | What went wrong | |---|---| | `onboarding/goal-field` | Onboarding flow unreachable — seeded instance already has a company, capture fell back to Dashboard | | `onboarding/new-company-modal-empty` | Same Dashboard fallback | | `onboarding/sidebar-new-company-button` | Same Dashboard fallback | | `work-modes/work-mode-picker` | Picker overlay click timed out (8s); shows Inbox without the picker open | | `routines/cron-picker` | Schedule-builder click timed out; shows routine Overview without the builder | Harness fixes needed before these can recapture: a company-less (or resettable) instance for the onboarding set, and longer interaction timeouts / fixed locators for the two pickers. ## Worth a look during review - `skills/assign-to-agent` shipped but is **partial**: the "Add to agent" button is visible but the dropdown isn't expanded. Usable, flagging for judgement. - **42 registry entries (21 logical) remain uncaptured** — they have `route: null` and a `_todo` note, i.e. never wired for automated capture. Mostly `company/*`, `tasks/*`, `org/*`, plus two export-import shots. Deciding whether to add routes for these is follow-up work, not part of this PR. - 8 PNGs on disk are pre-existing hand-made assets outside the registry (`hermes/*`, two diagrams) — untouched, expected. ## Checklist - [ ] Spot-check a few light/dark pairs render correctly in the docs - [ ] Confirm the five excluded captures' old images are still acceptable placeholders - [ ] File follow-up for the onboarding-harness fix + the 21 unrouted registry entries 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Fable 5 <[email protected]> |
||
|
|
8121a9c947 |
Release docs for paperclip v2026.720.0 (#67)
Ships the docs for **paperclip v2026.720.0** to `docs.paperclip.ing`. Window: `v2026.707.0...v2026.720.0` — 196 commits, 1,523 changed files, 0 truncated leaves. Most of this release was already drafted on `nightly` over the past cycle (Cases, Folders, Decision Training, Attention, Built-in Agents, company skill policy, inbox agent policy, `costStatus`, the ACP engine graduation and `acpx_local` retirement, and `PAPERCLIP_TOOL_ACTION_SIGNING_SECRET`). This PR adds the surfaces nightly had **not** yet covered, then stamps the release version across everything touched this cycle. ## New pages **`docs/reference/api/tool-gateway.md`** — the MCP Tool Gateway, the headline experimental feature. Covers applications and connections, catalog entries and risk levels, profiles/entries/bindings, the tool-access policy and its decision outcomes, named MCP gateways and their tokens, the audit feed, and the Smoke Lab. Documents the five `tools:*` permission keys and the viewer/membership rules on routes that don't use a permission key. Flags both experimental gates (`enableApps`, and `enableSmokeLab` separately). **`docs/reference/api/summary-slots.md`** — the built-in Summarizer and summary slots. Covers slot addressing (`scopeKind` / `scopeId` / `slotKey`), generation, revisions, and the `enableSummaries` gate. Cross-references Built-in Agents rather than duplicating it. ## Updated **`docs/guides/org/skills.md`** — Skill Studio (the three-pane authoring workspace, saved inputs, test runs and their unavailability reasons, run templates, version history), nested skill folders and the My Skills view, importing skills straight from a project, and company skill forks. Cross-references the existing Folders and Company Skill Policy API pages instead of restating them. ## Release stamping `paperclip_version: v2026.720.0` applied to all 26 pages touched this cycle — bumped on 10 that already had frontmatter, added to 13 that had none (including the API pages nightly authored, which were intentionally versionless until they merged to `main`). ## ↻ Renames detected `detect-renames.mjs` reports no directory renames. It flags one `removed_dirs_no_match`: - `packages/adapters/acpx-local` — **already reconciled on nightly.** The adapter was retired upstream (ACP became a capability of each harness adapter rather than a standalone adapter). `docs/reference/adapters/acpx-local.md` is now a retired stub that points at Claude Code / Codex / Gemini CLI and documents the automatic migration. No action needed. ## Screenshots — full overhaul recommended **248 of 298** registry entries are stale. This release landed a design-system convergence (single-source design tokens, retuned theme, broad Card/Badge adoption, a multiplicative radius ladder, unified list surfaces, Lucide task-status glyphs), so nearly every captured surface moved. This is an overhaul cycle, not a targeted refresh: ```sh npm run screenshots:refresh:all ``` Full per-entry breakdown in `SCREENSHOTS_PENDING.md`. Captures go to their own PR for review — nothing is auto-pushed. ## Verification - **Drift:** clean — 0 records against `903bd15` (8 parent paths, 57 CLI commands, 66 env vars, 389 REST routes, 18 permission keys, 4 roles). - **Claim verification:** `verify-edit.mjs` against `v2026.720.0` — **0 unverified, 0 suspicious** across all three authored files. - **Reconciliation:** no disappeared manifest entries. - **`npm run docs:build`:** passes — 169 markdown files, sitemap and robots generated. - **`npm run sync:check`:** links clean (172 files), nav clean, screenshots indexed, drift clean. - **Nav orphans:** `docs/reference/cli/commands.md` and `docs/reference/cli/control-plane-commands.md` — intentional redirect anchors, expected. `.sync-state.json` bumped to `base_release_tag: v2026.720.0` / `base_release_sha: 903bd157…`, which also repoints the drift checker's pinned ref (the previous `f12bb27…` no longer resolves upstream). No open `nightly-draft/*` PRs to fold in. ## Checklist - [ ] Tool Gateway page reads correctly for an operator enabling `enableApps` for the first time - [ ] Summary Slots experimental gating is accurate - [ ] Skill Studio guide matches what you see in the running UI - [ ] Decide whether to run the screenshot overhaul before or after merging this - [ ] **After squash-merging: run `node scripts/sync/realign-nightly.mjs release/v2026.720.0 --push` before the next nightly sync.** The squash severs `main`↔`nightly` ancestry; the realign (shipped in this PR) prevents add/add conflicts at the next nightly run. 🤖 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]> |
||
|
|
dcd77edb7e |
Use white text in dark theme (#66)
## Summary - replace the dark-theme manila primary text color with white - update dark code blocks, navbar CTA states, and footer text consistently ## Verification - `npm run docs:build` - confirmed generated output contains no `#f3e6c4`, `manila`, or `manilla` references Issue: PAP-14695 --------- Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> |
||
|
|
87bcacc731 |
docs: move desktop app guidance to unofficial community page (#65)
## Summary - Add a dedicated **Community Desktop App (unofficial)** guide covering installation, Local/Remote modes, server connections, updates, and troubleshooting. - Clearly identify `aronprins/paperclip-desktop` as community-maintained, unofficial, and unsupported by the Paperclip team. - Remove the desktop app as a primary installation/start path across the installation, update, quickstart, glossary, terminal setup, export/import, and overview docs. - Register the new page under **How-to Guides → Deploy & Maintain** and retain small cross-links where desktop-specific guidance is useful. ## Verification - `npm run docs:build` — passed on the final PR branch. - `sync:lint-links` — previously passed across 162 files with no broken links. - `sync:verify-nav` — previously passed with only two pre-existing orphan pages. - `docs:test:static-routes` — previously passed. - Verified the new route, sitemap entry, and cross-links in the built `.site` output. Closes PAP-14693. --------- Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
55de2cbb81 |
fix(sync): pin drift check to an immutable SHA, key cache by SHA (#62)
Ports the drift-checker fix to `main` (same change already merged to `nightly` in #61). `check-drift.mjs` is byte-identical across branches, so this cherry-pick applies cleanly. ## Problem The drift checker printed the parent's **live** SHA in its header but keyed its file cache by the moving name `drift-master` with no invalidation — reusing days-old file contents while claiming to check today's commit, silently hiding real drift. ## Fix - Resolve the ref to a full commit SHA before any reads; cache key = `drift-<sha>`, never `drift-master`. - Fail closed if the ref can't be resolved. - Mode-aware ref from `.sync-state.json` (release → `base_release_sha`, nightly → `last_seen_parent_sha`) before falling back to the default branch. `main` is release-mode, so its checks now pin to the release SHA instead of moving `master`. - Testable cache path (`PAPERCLIP_SYNC_CACHE_DIR` + fixture SHA stub); +2 regression tests. `npm run sync:test`: 37 passed, 0 failed. ## Triage note Running the fixed checker on `main`'s released docs against the release tag `v2026.707.0` returns **0 drift** — released docs are correct about the shipped product; this is a tooling fix only, no doc content changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.8 <[email protected]> |