paperclipai/paperclip-docs
1
0 Fork 0
mirror of https://github.com/paperclipai/paperclip-docs.git synced 2026-11-07 06:16:07 -10:00
Code Issues Packages Projects Releases Wiki Activity
Files
codex/https-setup-guide
paperclip-docs/PENDING.md
T
Aron PrinsClaude Opus 4.8DevRel GeminiPaperclipDottaClaudeCoder
 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]>
2026-09-17 11:15:48 +02:00

57 lines
6.9 KiB
Markdown
Raw Permalink Blame History

# Pending — nightly sync
_Regenerated from scratch each run by `/sync-docs` (nightly mode). Reflects the current cumulative manifest, not an append log._
- **Window (cumulative):** merge-base `dbf05257` → parent master `f2c5e54d` (HEAD @ 2026-09-13T13:41Z), 459 commits, 24h quarantine applied (commits after 2026-09-13T14:29Z held).
- **Base note:** the `v2026.831.1` release tag was cut off-master, so its recorded `base_release_sha` (`65ec059`) is not reachable from master. Per the "release tag diverges from master" rule, the cumulative base is the **merge-base** (`dbf05257`), not the tag SHA.
- **Compare truncation:** two leaves remained truncated at the 300-file cap (lockfile/generated-file mega-commits). Every concrete watcher path was intersected directly against the full window and the `.env.example` / `config.ts` diffs were pulled per-file (bypassing the cap), so **no docs-relevant file was dropped**.
- **Scope:** exhaustive.
## Applied this run
**Nothing drafted.** Every doc-relevant change in this window belongs to the already-deferred streamlined-UI/onboarding/connections cluster (see below), is quarantined, or is already documented. The auto-merge tier is empty: the `.env.example` additions in this window (`PAPERCLIP_ID_CONNECTOR_*`, `PAPERCLIP_HTTP_ADAPTER_PRIVATE_ENDPOINT_ALLOWLIST`) are all already present in `docs/reference/deploy/environment-variables.md` from prior runs. Drift is all false positives (re-confirmed this run). No reconciliation candidates.
`main` was already merged into `nightly` at run start (no new hotfix has landed on `main` since #122, "Add unlisted hosted beta guide and FAQ"). Ancestry intact — no realign needed.
## ⛔ Quarantined (held <24h — reconsider next run)
Commits after 2026-09-13T14:29Z are held. Both are fixes, not new user-visible surfaces:
- **Recent Tasks storage feedback fix** — `fix(ui): stop Recent Tasks storage feedback across tabs` (#13402, `d351e08`, 2026-09-14T13:05Z).
- **Clean-machine onboarding fix** — `fix: unblock clean-machine onboarding for api_key AI connections (nightly smoke)` (#13372, `13368c5`, 2026-09-14T00:02Z). Part of the AI-connections cluster; a fix, not new surface.
## Deferred — needs a scoped release-branch follow-up (NOT drafted this run)
The parent remains mid-flight on the **streamlined-UI + onboarding + connections refactor** flagged in prior runs. It stays feature-flagged (`*.production.tsx` vs `Legacy*`, experimental gates) and screenshot-dependent, so per nightly policy it is held for a deliberate release-branch pass with a screenshot refresh — not piecemeal nightly drafts from master. Newly aged out of quarantine since the last run, all folding into this same cluster:
- **iMessage Photon channel (experimental)** — `feat(channels): add experimental iMessage Photon` (#13299). New `server/src/services/photon/**` layer (receiver, adapter, media/attachments, cloud transport, recovery), `ui/src/pages/apps/chat/PhotonConnectStep.tsx`, and an `imessage-photon` app definition. Experimental; candidate home `docs/experimental/`. Draft on the release-branch pass.
- **AgentMail inboxes & email tasks** — `feat(connections): add AgentMail inboxes and email tasks` (#13256) plus follow-ups. New `skills/agentmail/SKILL.md`, `server/src/services/connectors/agentmail.ts`, `server/src/routes/email.ts`, `ui/src/components/Email*`. Part of the connections cluster; entangled with the email-endpoint setup UI.
- **AI Connections credential management** — `feat: manage AI runtime credentials through Connections` (#13247) and `feat: reuse provider sign-in across AI connection workflows` (#13248). Reworks how agents get provider credentials: `ui/src/components/ai-connections/**`, `ui/src/api/ai-connections.ts`, `server/src/routes/ai-connections.ts`. Cross-cuts onboarding and the new-agent flow; screenshot-dependent.
- **Persistent agent chat (experimental)** — `feat: add experimental persistent agent chat` (#13284). New `ui/src/pages/AgentChat.tsx`, `SidebarAgentChats`, `agent_chat` schema/migration. Experimental; gated.
- **Native chat connectors (experimental)** — earlier `889947c` (#13038) Slack/Discord/Teams publication + inbound wakeups; `ui/src/pages/apps/chat/**`. Gated behind the chat-connectors experimental flag. Candidate home `docs/experimental/`.
- **Onboarding rework** — simplified agent onboarding/configuration (#13011) and chief-of-staff-first-task flow (#13317 makes hiring reliable), reuse of saved model connections. Cross-guide rewrite of `docs/guides/getting-started/*`; needs screenshots.
- **GitHub connection & repository access** — multi-repo selection, shared-agent GitHub identity, simplified access controls, duplicate-connection resolution. Targets `docs/how-to/connect-agent-to-github.md`; entangled with `ConnectionSetupFlow`.
Behavioural removal to reconcile on the follow-up (not a nightly drift item, it is a genuine removal):
- **Automatic productivity reviews removed** — `refactor: remove automatic productivity reviews` (#13263). `server/src/services/productivity-review.ts` and `ui/src/components/ProductivityReviewBadge.tsx` are gone. If any guide/day-to-day page describes automatic productivity reviews, it needs a removal edit on the release-branch pass.
- **Screenshots** — **230 of 342 stale** across 46 routes (see `SCREENSHOTS_PENDING.md`). Run `npm run screenshots:refresh` in the follow-up; PNGs go to a PR for review, never auto-pushed.
## ⚠ Drift (Phase 1.5) — all triaged, no action
14 records, every one a re-confirmed false positive (spot-checked against current master this run):
- **env-var `PAPERCLIP_WORKSPACE_GIT_SCAN_*` (high, 4)** — `CONCURRENCY`, `QUEUE_CAPACITY`, `TIMEOUT_MS`, `CACHE_TTL_MS`. Present (commented) in `.env.example` and read by the workspace-git scan scheduler.
- **env-var `PAPERCLIP_ID_CONNECTOR_*` (high, 5)** — `BASE_URL`, `ENVIRONMENT`, `INSTANCE_ID`, `SIGN_PRIVATE_KEY`, `SEAL_PRIVATE_KEY`. Present (commented) in `.env.example` + the cloud-connector service. Not reverted, so no reconciliation needed.
- **rest-route companies `import/transfers` (medium, 5)** — `POST/PUT/GET/POST/POST /api/companies/import/transfers…`. All registered in `server/src/routes/companies.ts` via `COMPANY_IMPORT_TRANSFERS_ROUTE_PATH` (confirmed present this run).
> Note: the `env-var-missing` class keeps re-flagging vars that live in `.env.example` under grouped/prefixed **commented** blocks the drift scanner can't match line-for-line. Candidate check-drift refinement, not a docs bug.
## ⚠ Reconcile (Phase 3.5)
- None. Prior runs drafted no doc edits, and nothing flagged in prior runs has been reverted upstream.
## Pre-existing gaps noticed (out of scope this run)
- The `worktree` CLI command family (`worktree:make`, `worktree init`, `worktree env`, …) is not documented on any CLI page.
- `issues.md` does not document the `/issues/:id/work-products` route family or several `GET /issues/{id}` response fields/query params (unchanged this window).
Reference in new issue View Git Blame Copy Permalink