mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 23:02:28 -10:00
codex/https-setup-guide
30
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
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]> |
||
|
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]>
|
||
|
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 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]> |
||
|
|
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]> |
||
|
|
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]> |
||
|
|
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]> |
||
|
|
773f72838a |
docs: Checkbox Confirmations API reference (v2026.609.0) (#54)
## Summary - New API reference page `docs/reference/api/checkbox-confirmations.md` for the `request_checkbox_confirmation` issue-thread interaction kind (shipped in v2026.609.0, paperclipai/paperclip#7649): create/list/accept/reject routes, full payload schema + validation limits, results/outcomes, continuation policy, target staleness, idempotency. - Registered in the API nav (`site/content.json`) after Issues. - Card screenshot added under `docs/user-guides/screenshots/{light,dark}/interactions/` (same capture both themes — the delegated QA pass produced a light capture; swap-safe path). Campaign v2026-609-0 · piece `api-docs--checkbox-confirmations` · PAP-13235. **Merging this PR = publishing the page** (delivery gate for the campaign piece). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: DevRel Gemini <[email protected]> Co-authored-by: Paperclip <[email protected]> |
||
|
Aron Prins
|
7e25158fca |
Release docs for paperclip v2026.707.0 (#49)
Promotes v2026.707.0 docs from nightly: Custom sandbox images + Ramp skill (new), Work Timeline (#48) and Secret scopes (#47) content, screenshot capture targets, environments nav reconcile, sync-state bump to v2026.707.0, and accuracy fixes from adversarial verification. 0 drift. |
||
|
Aron PrinsandClaude Opus 4.8
|
2368a2be5f |
Release docs for paperclip v2026.618.0
Promote nightly drafts (v2026.609.0 → v2026.618.0) to main and fill coverage gaps. New surfaces authored: - Novita Agent Sandbox provider (driver: novita) — sandbox-providers.md - paperclip-board bundled skill — skills.md (skills/ went 5 → 6; "four" → "five") Promoted nightly drafts (all ⊆ v2026.618.0, no post-tag leakage): - adapters: codex/gemini/opencode/pi/openclaw-gateway, sandbox-providers (Kubernetes) - api/agents, plugins/sdk, environment-variables (TRUST_PROXY/OTEL) - day-to-day guides: artifacts, issues, routines Stamped paperclip_version: v2026.618.0 on all 13 touched pages. Regenerated SCREENSHOTS_PENDING.md (90/276 stale — flag only, separate capture PR). Deferred: experimental conference-room board-chat (flag-gated). sync:check clean (no broken links); drift = 5 known server-env false positives. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
acfebdf637 |
nightly: K8s sandbox provider, adapter gateway routing, TRUST_PROXY/OTEL, agent read-config access (paperclip 412a04c)
Cumulative window v2026.609.0 -> master HEAD 412a04c (59 commits). Applied:
- environment-variables.md: TRUST_PROXY (reverse-proxy trust), OpenTelemetry
opt-in tracing (OTEL_*), and adapter provider-override env vars.
- api/agents.md: read-only config/skill/config-revision endpoints no longer
require agents:create for board members (agents still gated).
- adapters/sandbox-providers.md: new Kubernetes sandbox provider section.
- adapters/{codex,pi,opencode}-local.md: PAPERCLIP_*_PROVIDERS gateway routing
(+ codex GPT-5.5 / omit-default-model, opencode small-model).
- adapters/gemini-local.md: headless auth pre-selection + token-overflow
fresh-session retry.
- adapters/openclaw-gateway.md: role/scopes/paperclipApiUrl/workspaceRuntime.
- plugins/sdk.md: optional companyId tenant scoping on metrics.write + log.
Deferred (experimental/half-built) to PENDING.md: Conference Room Chat,
Skills Store, dark mode, onboarding NUX, activity feed, issues list filters.
All edits verified against parent code (Phase 5.5).
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
|
||
|
Aron PrinsandClaude Opus 4.8
|
b243dfe70d |
Release docs for paperclip v2026.609.0
Publish accumulated nightly drafts to main and document the new surfaces shipped between v2026.529.0 and v2026.609.0 (130 parent commits). New pages (gaps not covered by nightly drafts): - docs/reference/cli/token.md — `token agent` / `token board` API-key commands - docs/reference/cli/connect.md — interactive `connect` setup wizard - docs/reference/api/teams-catalog.md — teams catalog REST API Also: - Stamp paperclip_version: v2026.609.0 on 49 release doc pages - Register the 3 new pages in site/content.json nav - Bump .sync-state.json base_release_tag to v2026.609.0 Verification: 49 pages checked against v2026.609.0; 11 verifier flags, all confirmed false-positives (flagged flags/env-vars exist in parent). Drift: 0. Reconciliation: 0. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
3b58fb017c |
nightly: Teams Catalog, Company Artifacts, low-trust review presets (paperclip a800140)
Three settled surfaces aged past the 24h quarantine since the last run: - Teams Catalog (#7550): new `teams` CLI page + Team Catalog guide for the installable bundled/optional starter teams. - Company Artifacts (#7621): new Artifacts guide + `GET /api/companies/{id}/artifacts` API section under Companies. - Low-trust review containment / trust presets (#7530): new Administration page covering the `standard` / `low_trust_review` presets and quarantine-then-promote review flow. Nav merged in site/content.json. PENDING.md and SCREENSHOTS_PENDING.md regenerated (40 screenshots stale in the settled window). Phase 5.5 verification clean; drift clean. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
44d4c5d604 |
nightly: referenced catalog skills (last30days), routine pause-suppression, company archive cascade
Cumulative window v2026.529.0 → e78c064 (24h-quarantined nightly cutoff). Three user-visible surfaces newly documented this run: - skills: app-shipped catalog now supports *referenced* entries fetched from an external GitHub repo pinned to a commit (CatalogSkill.source). First one is the research-category last30days skill. Documented in the Skills reference and the org Skills guide. - routines: scheduled ticks are suppressed (recorded as skipped, no backfill) while the routine's project is paused. - companies: archiving runs a cascade that pauses active agents (pauseReason company_archived) and cancels queued wake-ups. All claims verified against parent code (Phase 5.5 clean). Build + link/nav checks pass; no drift. Teams Catalog, company-artifacts page, and low-trust review containment are quarantined (<24h) and deferred to the next run. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
70ed497e12 |
nightly: full CLI reference handbook + wireframe skill + OpenAPI endpoint
CLI API-parity coverage (paperclip #6626, parent 03e1e3ab) cleared 24h quarantine and is now eligible. Adopt the comprehensive per-command CLI reference under Reference → CLI, replacing the single-page commands.md monolith. Guide/runbook track deferred to a later expansion. - Reference → CLI rebuilt to 28 per-command pages (overview, installation, common-options, output-and-scripting, setup, dev-environments, authentication, company, project, goal, issue, agent, prompt, run, routine, adapter, approval, activity, dashboard, cost, workspace, access, skills, secrets, cloud, plugin, asset, feedback). - Retire commands.md + control-plane-commands.md → "moved" tombstones plus route redirects in site/redirects.json. Repoint inbound links (reference/skills.md, how-to/sync-to-cloud-upstream.md). - Rewrite deferred-guide links to existing equivalents; smooth an installation.md example that tripped a drift false-positive. - Document the bundled `wireframe` catalog skill (reference/skills.md, guides/org/skills.md). - Add the GET /api/openapi.json endpoint to the API overview (server/src/routes/openapi.ts). Verified: docs:build OK, sync:check OK (links clean, drift 0, screenshots indexed; 2 intended tombstone orphans). Regenerated PENDING.md + SCREENSHOTS_PENDING.md; updated .sync-state.json. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
5f08200d05 |
nightly: issue artifacts — output playback, attachment streaming, skill upload
Cumulative window v2026.529.0 → parent master edeab22c (24h quarantine). One feature cluster: agent-produced issue artifacts (video/file deliverables) that reviewers — including cloud reviewers without workspace access — can view and play back on the board. - docs/reference/api/issues.md — attachment openPath/downloadPath, ?download=1 disposition, HTTP Range (206) streaming, video/zip allowed types + inference. - docs/reference/skills.md — bundled paperclip skill artifact-upload helper. - docs/guides/day-to-day/issues.md — Output section + inline video / open-vs-download. All 3 PR-tier edits verified against parent (verify-edit: 39/39 on api/issues, 0 unverified across all). docs:build + sync:check green. Drift: none. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
9c5aae8962 |
Release docs for paperclip v2026.529.0
Add the two release features quarantined from nightly, and stamp paperclip_version on every touched page. - Claude Local: document UI-driven live model discovery (#6953) — /v1/models lookup via ANTHROPIC_API_KEY, 60s cache, built-in fallback, Bedrock IDs, and the refresh control. - Workspaces: document reused-workspace environment consistency and finalize-gated dependent wakes / interaction.accept (#6969). - Stamp paperclip_version: v2026.529.0 on all 14 touched pages. - Regenerate SCREENSHOTS_PENDING.md: 90/276 stale for this window. Inherits the six features already drafted on nightly: resource memberships (#6677), document annotations (#6733), bundled plugins in plugin manager (#6734), skills CLI + catalog (#6782), first-admin claim (#6755). Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.8
|
534a8b4c0d |
nightly: skills CLI + catalog, first-admin browser claim (paperclip 524e18b)
Cumulative nightly sync v2026.525.0 → parent master 524e18b (24h quarantine). - Skills CLI command group (paperclipai skills …): control-plane workflow section + full subcommand/flag reference (#6782). - App-shipped skills catalog (bundled/optional) + install-catalog / audit / install-update / reset lifecycle in the skills reference and org guide (#6782). - Private browser first-admin claim (POST /api/bootstrap/claim) in the instance-admin API reference and installation guide (#6755). Verified against parent: 0 high-confidence unverified claims. No drift, no renames, no auto-merge/env changes. 5 commits held in quarantine. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.7
|
51b9fe35bb |
nightly: resource memberships, document annotations, bundled plugins (paperclip b754582)
Cumulative nightly sync from v2026.525.0 → parent master b754582: - New API page for resource memberships (join/leave projects & agents) - Document annotations API + guide sections on issue documents - Bundled plugin discovery (experimental first-party plugins) in admin + API docs Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.7
|
ee349a369a |
Release docs for paperclip v2026.525.0 (#14)
* nightly: regenerate PENDING manifest (paperclip c0c5a82) 10 PR-tier candidates against v2026.517.0..master: - modal sandbox provider plugin (new doc page) - worktree init --force scope fix - routine env runtime contract (migration 0086) - workspace diff viewer plugin (new) - plugin SDK surface + managed-resources concept - environmentProbe RPC timeout 120s - SecretBindingPicker in JsonSchemaForm - inbox planning badge removed - secret form textarea overflow fix - new-issue autocomplete pointer fix No drift, no reconciliation candidates. All 14 parent commits past quarantine. Anchor-map db-migrations watcher path is stale (packages/db/migrations -> packages/db/src/migrations) — noted for maintenance. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> * nightly: document Modal sandbox provider (paperclip 4b1e92a..e5a0f5d) * nightly: clarify scope of worktree init --force (paperclip 242a2c2) * nightly: document routine env + secret-ref binding picker (paperclip 705c1b8..c0c5a82) * nightly: document workspace diff viewer plugin (paperclip 5071c4c) * nightly: audit plugin SDK reference + add managed resources note (paperclip c0c5a82) * nightly: nav for modal adapter and workspace-diff plugin Merges the two NAV_ADDITION entries returned by the doc-draft subagents in this run, in one coordinated edit so the index file stays consistent. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> * nightly: workspace diff polish + manifest refresh (paperclip f2575305) - docs/reference/plugins/workspace-diff.md: document split/unified toggle, working-tree vs against-ref toggle, base-ref input with defaultBaseRef prefill, sticky toolbar, and head → working-tree fallback when no base ref is set (paperclip #6383). - PENDING.md: regenerate cumulative manifest against parent f2575305 (20 commits in window, 13 doc-relevant entries). Adds entries for the provider vault secrets UX (#6381), cheap recovery model guard (#6371), sidebar fix (#6341), cloud tenant import exemption (#6378), and UI/dev QoL polish (#6384). - .sync-state.json: bump last_seen_parent_sha to f2575305, refresh manifest hash, mark applied. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> * docs(nightly): add troubleshooting for 401 after creating a new secret Customer hit a 401 after adding a new secret at the company level. The new how-to didn't flag that creating a secret doesn't auto-rewire the agent's env-var binding — fixed by adding two troubleshooting entries covering the unbound-secret case and the provider-side rejection path. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> * nightly: manifest refresh (paperclip e3c875c, effective c91a062) Cumulative window v2026.517.0 → c91a062 (21/29 commits; 8 quarantined). Adds entry #14 for #6380 runtime control-plane fixes — overwhelmingly internal correctness, surfaced as context-only with a note on the new PORTABLE_JSON_BODY_LIMIT (64mb) constant for portable imports. All 13 prior entries still present in the cumulative diff — no reconciliation. Drift check clean. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> * release: docs for paperclip v2026.525.0 Roll-up of nightly drafts plus newly-authored coverage for surfaces shipped in v2026.525.0 that nightly hadn't reached yet: - new: docs/how-to/sync-to-cloud-upstream.md (Cloud Upstream sync flow) - new: docs/how-to/connect-aws-secrets-vault.md (AWS provider vault discovery) - update: docs/reference/cli/commands.md — paperclipai cloud connect/push - update: docs/reference/adapters/acpx-local.md — bare Claude model IDs, structured diagnostics, ~/.claude/settings.json handling - update: docs/reference/api/agents.md — scoped permissions + authorization service, decision-reason table - update: docs/reference/api/issues.md — retry-now endpoint - update: docs/reference/deploy/secrets.md — Provider Vaults section - update: docs/how-to/bring-your-own-agent.md — invite flow moved into add-agent modal Bumped paperclip_version frontmatter to v2026.525.0 on all touched pages (including nightly-authored Modal, workspace-diff, plugin SDK, routines, worktree --force pages). Updated .sync-state.json: base_release_tag v2026.517.0 -> v2026.525.0. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> --------- Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]> |
||
|
Aron Prins
|
471de65da1 | fix: harden docs rendering and stale references | ||
|
Aron PrinsandClaude Opus 4.7
|
bd1799fc8d |
Release docs for paperclip v2026.517.0
- New adapter page: Grok Local (`grok_local`), wired into the Adapters overview table and nav. - Issues guide: document locking workflow (lock/unlock, derived-document redirect for agents) and the new Board-view scaling controls (density, cold-lane mode, column page size). Documents are now live-refreshed. - Issues API reference: lock / unlock endpoints, plus the `redirectedFromLockedDocument` response for agent writes into locked documents. - Sandbox Providers (Cloudflare): reliability tuning notes — larger instance type, SSE keepalives, UTF-8-safe stdout, sandbox-aware probe budgets, corrected Pi install path. - LLM Wiki plugin: bundled bootstrap assets and namespace-safe spaces migration validation. - SCREENSHOTS_PENDING.md regenerated for v2026.517.0. - .sync-state.json bumped to v2026.517.0. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.7
|
68d514fb26 |
Release docs for paperclip v2026.513.0
Authored docs to track the v2026.512.0 → v2026.513.0 window: - New: docs/how-to/develop-a-plugin-locally.md — friendly walkthrough of `paperclipai plugin init`, local-path install, dev watcher, reload. - New: docs/guides/day-to-day/blocked-inbox.md — guide to the new Blocked Inbox tab, chip variants, filters, sort, and triage. - docs/guides/day-to-day/issues.md — Blocked tab cross-ref; new "Recovery actions" and "Walking through sub-issues" sections. - docs/reference/api/issues.md — "Recovery actions" API section (routes, RecoveryAction shape, resolution-outcome enum). - docs/reference/adapters/claude-local.md — "Resuming a session's workspace" subsection (host cwd, system-root rejection, non-file skip, driver-plugin allowlist). - docs/reference/plugins/sdk.md — "Worker entrypoint validation" section; version bumped to v2026.513.0. - docs/administration/plugins.md — "Developing plugins locally" subsection linking the new how-to. - site/content.json — nav entries for the two new pages. - SCREENSHOTS_PENDING.md — new UI surfaces flagged for capture. Co-Authored-By: Claude Opus 4.7 <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.7
|
2b5368e5af |
release: address v2026.512.0 coverage gaps
Closes the four coverage gaps surfaced by the docs audit: Gap 1 — env vars (verify-edit: 0 high-confidence unverified) - docs/reference/deploy/environment-variables.md - Added `BETTER_AUTH_SECRET` row to "Deployment And Auth" (falls back to `PAPERCLIP_AGENT_JWT_SECRET`; server refuses to start without either), and `SERVE_UI` row to "Server Configuration" (overrides `server.serveUi`). Both values copied verbatim from parent at v2026.512.0 (.env.example + server/src/auth/better-auth.ts). Gap 2 — skill bundles (verify-edit: 0 unverified) - docs/reference/skills.md - Added one-liner entries for `diagnose-why-work-stopped`, `paperclip-converting-plans-to-tasks`, `para-memory-files`, `terminal-bench-loop`. Descriptions distilled from each parent `SKILL.md` frontmatter at v2026.512.0. Gap 3 — Plugin SDK page (verify-edit: 0 high-confidence unverified) - docs/reference/plugins/sdk.md (new) - site/content.json (new "Plugins" section under Reference tier) - Comprehensive reference for @paperclipai/plugin-sdk. Every public export (definePlugin, runWorker, startWorkerRpcHost, test harness, bundler presets, dev server, host-client factory, JSON-RPC protocol helpers, all manifest/protocol types, zod re-export, constants) is listed verbatim from packages/plugins/sdk/src/index.ts at v2026.512.0. 13 unverified items are SHOUT_CASE SDK constants mis-classified as env vars by verify-edit (all confidence: null). Gap 4 — REST routes (verify-edit: 0 high-confidence unverified) - docs/reference/api/adapters.md (new) — 9 endpoints from server/src/routes/adapters.ts. - docs/reference/api/plugins.md (new) — install/lifecycle/config/jobs/ webhooks/local-folders/bridge endpoints from server/src/routes/plugins.ts. - docs/reference/api/instance-admin.md (new) — umbrella covering instance-settings, instance-database-backups, llms reflection, environments, and execution-workspaces. - site/content.json — added the three new pages to the API section. - All seven flagged route files turned out to be public/admin surfaces; none qualified as internal-only. FOLLOW-UPS.md - Added "Internal REST routes — intentionally undocumented" section recording the Gap 4 triage outcome. Verification gates - npm run sync:test — 26/26 passed - npm run docs:build — clean (90 markdown files) - npm run sync:lint-links — same 3 pre-existing broken screenshots - npm run sync:verify-nav — same 1 pre-existing orphan - check-drift: 41 -> 43 (+2; both are the new SERVE_UI / BETTER_AUTH_SECRET rows hitting the known env-var-missing false-positive class tracked in FOLLOW-UPS.md; the routes-missing item for instance-admin.md is a filename-normalization false positive — routes exist in parent). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> |
||
|
DottaandPaperclip
|
92e34c1dee |
Expand R4 issue lifecycle reference with mermaid + common mistakes
- Add a collapsible Mermaid state-diagram alongside the ASCII diagram for renderers that support it. - Document that release preserves assigneeUserId (verified against svc.release in the runtime: only assigneeAgentId, checkoutRunId, and status are written). - Add a Common Mistakes table covering PATCHing into in_progress, retrying 409s, free-text blockers, cancelled blockers, executionState participant rules, reopen vs status, and the X-Paperclip-Run-Id header. Co-Authored-By: Paperclip <[email protected]> |
||
|
DottaandPaperclip
|
eb3c4a4c09 |
Add skills reference (R6)
Adds docs/reference/skills.md covering file shape, install pipeline, assignment, scoping, skill-vs-plugin-vs-adapter, naming collisions, versioning, and troubleshooting. Wires it into the Reference tier in content.json and updates the org skills guide to link to it. Also corrects the agents API page, which advertised skillIds/skillKeys for /agents/:id/skills/sync but the validator only accepts desiredSkills. Co-Authored-By: Paperclip <[email protected]> |
||
|
DottaandPaperclip
|
93ef8292de |
Expand skills/sync and request_board_approval payload docs
- docs/reference/api/agents.md: add skills/sync request body fields (skillIds, skillKeys), worked examples in three languages, and the desiredSkills hire-time pointer. - docs/reference/api/approvals.md: add the per-type payload shape table for request_board_approval, with the title/summary/ recommendedAction/risks fields and a JSON example, plus brief notes on approve_ceo_strategy and hire_agent payloads. Refs PAP-2507, PAP-1815, PAP-1819. Co-Authored-By: Paperclip <[email protected]> |
||
|
DottaandPaperclip
|
53ebf1d18d |
Document inbox-lite, issue interactions, and lifecycle cross-link
- docs/reference/api/agents.md: add the GET /api/agents/me/inbox-lite surface (compact heartbeat inbox with dependencyReady, blocker counts, activeRun) so agents can use it without reading the heartbeat skill. - docs/reference/api/issues.md: add the issue Interactions API (suggest_tasks, ask_user_questions, request_confirmation) including accept/reject/respond, the idempotency-key pattern for plan approvals, and the recommended plan-approval sequence. - docs/guides/day-to-day/issues.md: link from the Status Reference to the new state-machine reference. Refs PAP-2507, PAP-1815, PAP-1817. Co-Authored-By: Paperclip <[email protected]> |
||
|
DottaandPaperclip
|
3e78cda1b3 |
Expand issue lifecycle and agent runtime env var reference
- docs/reference/api/issues.md: replace the minimal lifecycle stub with a full state-machine reference: status table, ASCII state diagram, allowed-transitions table, automatic side effects, executionState/review-stage notes, blockedByIssueIds semantics, and hiddenAt. - docs/reference/deploy/environment-variables.md: add PAPERCLIP_WAKE_PAYLOAD_JSON, an "Always set?" column on the agent-runtime table, the full PAPERCLIP_WAKE_REASON enumeration, and an X-Paperclip-Run-Id audit-trail callout. Refs PAP-2507, PAP-1817, PAP-1820. Co-Authored-By: Paperclip <[email protected]> |
||
|
Aron PrinsandClaude Opus 4.7
|
56b8d7d52d |
Refactor docs IA into Guides + Reference tiers; add 10 new guides
Reorganise all docs under a two-tier sidebar (Guides / Reference) with
tier-grouped landing cards that auto-size to the section count (3-col
default, 2x2 when a tier has 4 cards).
Moves
- docs/user-guides/guides/** -> docs/guides/{welcome,getting-started,
day-to-day,org,projects-workflow,power}/
- docs/{api,cli,adapters,deploy} -> docs/reference/{api,cli,adapters,deploy}
- New docs/administration/ for company/settings/plugins/cli-auth
- 265 internal cross-links rewritten by scripts/rewrite-links.mjs
- site/redirects.json preserves old URLs
New guides
- guides/org/agents.md (absorbs how-agents-work.md)
- guides/day-to-day/issues.md (absorbs managing-tasks.md)
- guides/day-to-day/costs.md (absorbs costs-and-budgets.md)
- guides/projects-workflow/routines.md (absorbs heartbeats-and-routines.md)
- guides/projects-workflow/workspaces.md (absorbs execution-workspaces.md)
- guides/projects-workflow/projects.md
- guides/projects-workflow/goals.md
- guides/org/adapters.md (AdapterManager UI walkthrough)
- administration/{company,settings,plugins,cli-auth}.md
Expanded
- approvals.md, skills.md, org-structure.md with missing UI walkthroughs
Site
- content.json: tier field, merged Welcome into Getting Started, collapsed
Administration to single section
- app.js: tier-grouped sidebar + landing; redirect map on route changes
- styles.css: tier headers and adaptive landing grid
Screenshots
- docs/user-guides/screenshots/SCREENSHOTS_TODO.md runbook for capturing
on a disposable demo instance. No screenshots captured in this branch.
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|