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
main
paperclip-docs/site/content.json
T
Aron PrinsClaude Opus 4.8DevRel GeminiPaperclipDottaClaudeCoder
 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]>
2026-11-07 13:02:42 +01:00

1487 lines
43 KiB
JSON
Raw Permalink Blame History

{
"sections": [
{
"tier": "Learn",
"title": "Quickstart",
"icon": "rocket",
"desc": "Learn what Paperclip is, install it, create your first company, hire an agent, and watch it work.",
"pages": [
{
"title": "Quickstart Path",
"file": "../docs/guides/getting-started/five-minute-path.md"
},
{
"title": "What is Paperclip?",
"file": "../docs/guides/welcome/what-is-paperclip.md"
},
{
"title": "Key Concepts",
"file": "../docs/guides/welcome/key-concepts.md"
},
{
"title": "Installation",
"file": "../docs/guides/getting-started/installation.md"
},
{
"title": "Create Your First Company",
"file": "../docs/guides/getting-started/your-first-company.md"
},
{
"title": "Hire Your First Agent",
"file": "../docs/guides/getting-started/your-first-agent.md"
},
{
"title": "Watching Agents Work",
"file": "../docs/guides/getting-started/watching-agents-work.md"
},
{
"title": "Glossary",
"file": "../docs/guides/welcome/glossary.md"
}
]
},
{
"tier": "Learn",
"title": "Working Day-to-day",
"icon": "layout-dashboard",
"desc": "Day-to-day operation: dashboard, tasks, approvals, budgets, and the activity log.",
"pages": [
{
"title": "The Dashboard",
"file": "../docs/guides/day-to-day/dashboard.md"
},
{
"title": "Command Palette",
"file": "../docs/guides/day-to-day/command-palette.md"
},
{
"title": "Issues",
"file": "../docs/guides/day-to-day/issues.md"
},
{
"title": "Work Modes",
"file": "../docs/guides/day-to-day/work-modes.md"
},
{
"title": "Artifacts",
"file": "../docs/guides/day-to-day/artifacts.md"
},
{
"title": "Blocked Inbox",
"file": "../docs/guides/day-to-day/blocked-inbox.md"
},
{
"title": "Decisions",
"file": "../docs/guides/day-to-day/decisions.md"
},
{
"title": "Approvals",
"file": "../docs/guides/day-to-day/approvals.md"
},
{
"title": "Costs & Budgets",
"file": "../docs/guides/day-to-day/costs.md"
},
{
"title": "Activity Log",
"file": "../docs/guides/day-to-day/activity-log.md"
},
{
"title": "Work Timeline",
"file": "../docs/guides/day-to-day/work-timeline.md"
},
{
"title": "Feedback & Voting",
"file": "../docs/guides/day-to-day/feedback-voting.md"
}
]
},
{
"tier": "Learn",
"title": "Your Org & Agents",
"icon": "network",
"desc": "Shape the org chart, set up delegation paths, and pick adapters for your agents.",
"pages": [
{
"title": "Agents",
"file": "../docs/guides/org/agents.md"
},
{
"title": "Agent Identity",
"file": "../docs/guides/org/agent-identity.md"
},
{
"title": "Skills",
"file": "../docs/guides/org/skills.md"
},
{
"title": "Team Catalog",
"file": "../docs/guides/org/team-catalog.md"
},
{
"title": "Org Structure",
"file": "../docs/guides/org/org-structure.md"
},
{
"title": "Members & Access",
"file": "../docs/guides/org/members-and-access.md"
},
{
"title": "Delegation",
"file": "../docs/guides/org/delegation.md"
},
{
"title": "Agent Adapters",
"file": "../docs/guides/org/agent-adapters.md"
},
{
"title": "Adapter Manager",
"file": "../docs/guides/org/adapters.md"
}
]
},
{
"tier": "Learn",
"title": "Connectors",
"icon": "unplug",
"desc": "Connect outside services to your agents: app integrations, model providers, and chat channels, plus the access model, per-action permissions, and a setup guide for each one.",
"pages": [
{
"title": "Connectors Overview",
"file": "../docs/connectors.md"
},
{
"title": "Your First Connector",
"file": "../docs/connectors/first-connector.md"
},
{
"title": "How Access Works",
"file": "../docs/connectors/access-model.md"
},
{
"title": "Prompt Injection Prevention",
"file": "../docs/connectors/prompt-injection-prevention.md"
},
{
"title": "Shared Guides",
"pages": [
{
"title": "Share With People and Agents",
"file": "../docs/connectors/share-access.md"
},
{
"title": "Separate Accounts",
"file": "../docs/connectors/separate-accounts.md"
},
{
"title": "Action Permissions",
"file": "../docs/connectors/action-permissions.md"
},
{
"title": "Connection Instructions",
"file": "../docs/connectors/connection-instructions.md"
},
{
"title": "Review Requests",
"file": "../docs/connectors/review-requests.md"
},
{
"title": "Verify and Troubleshoot",
"file": "../docs/connectors/verify-and-troubleshoot.md"
},
{
"title": "Reauthorize and Disconnect",
"file": "../docs/connectors/reauthorize-and-disconnect.md"
},
{
"title": "Custom MCP Servers",
"file": "../docs/connectors/custom-mcp-servers.md"
},
{
"title": "MCP Aggregators",
"file": "../docs/connectors/mcp-aggregators.md"
},
{
"title": "Google Workspace Setup",
"file": "../docs/connectors/google-setup.md"
},
{
"title": "Custom Model Providers",
"file": "../docs/connectors/custom-model-providers.md"
},
{
"title": "Check AI Usage",
"file": "../docs/connectors/ai-usage.md"
},
{
"title": "Memory Connectors (Experimental)",
"file": "../docs/connectors/memory-connectors.md"
}
]
},
{
"title": "Recognized but Unlisted",
"file": "../docs/connectors/recognized-providers.md"
},
{
"title": "Connector Catalog",
"pages": [
{
"title": "AgentMail",
"file": "../docs/connectors/agentmail.md"
},
{
"title": "Airtable",
"file": "../docs/connectors/airtable.md"
},
{
"title": "Anthropic",
"file": "../docs/connectors/anthropic.md"
},
{
"title": "Arcade",
"file": "../docs/connectors/arcade.md"
},
{
"title": "Asana",
"file": "../docs/connectors/asana.md"
},
{
"title": "Bitly",
"file": "../docs/connectors/bitly.md"
},
{
"title": "Box",
"file": "../docs/connectors/box.md"
},
{
"title": "Braintrust",
"file": "../docs/connectors/braintrust.md"
},
{
"title": "Browser Use Cloud",
"file": "../docs/connectors/browser-use-cloud.md"
},
{
"title": "Calendly",
"file": "../docs/connectors/calendly.md"
},
{
"title": "ClickHouse",
"file": "../docs/connectors/clickhouse.md"
},
{
"title": "Cloudflare",
"file": "../docs/connectors/cloudflare.md"
},
{
"title": "Cloudinary",
"file": "../docs/connectors/cloudinary.md"
},
{
"title": "Cognee",
"file": "../docs/connectors/cognee.md"
},
{
"title": "Composio",
"file": "../docs/connectors/composio.md"
},
{
"title": "Context7",
"file": "../docs/connectors/context7.md"
},
{
"title": "Daytona",
"file": "../docs/connectors/daytona.md"
},
{
"title": "Discord",
"file": "../docs/connectors/discord.md"
},
{
"title": "Ditto",
"file": "../docs/connectors/ditto.md"
},
{
"title": "Enterpret",
"file": "../docs/connectors/enterpret.md"
},
{
"title": "Exa",
"file": "../docs/connectors/exa.md"
},
{
"title": "Executor",
"file": "../docs/connectors/executor.md"
},
{
"title": "Firecrawl",
"file": "../docs/connectors/firecrawl.md"
},
{
"title": "Fireflies",
"file": "../docs/connectors/fireflies.md"
},
{
"title": "Gauge",
"file": "../docs/connectors/gauge.md"
},
{
"title": "GitHub",
"pages": [
{
"title": "Overview",
"file": "../docs/connectors/github.md"
},
{
"title": "Connector Setup",
"file": "../docs/connectors/github-setup.md"
},
{
"title": "Understanding Review Bots",
"file": "../docs/connectors/understanding-github-review-bots.md"
},
{
"title": "Set Up a Review Bot",
"file": "../docs/connectors/github-review-bot-setup.md"
},
{
"title": "GitHub Copilot",
"file": "../docs/connectors/github-copilot.md"
}
]
},
{
"title": "Gmail",
"file": "../docs/connectors/gmail.md"
},
{
"title": "Gmail Setup",
"file": "../docs/connectors/gmail-setup.md"
},
{
"title": "Google Calendar",
"file": "../docs/connectors/google-calendar.md"
},
{
"title": "Google Chat",
"file": "../docs/connectors/google-chat.md"
},
{
"title": "Google Docs",
"file": "../docs/connectors/google-docs.md"
},
{
"title": "Google Drive",
"file": "../docs/connectors/google-drive.md"
},
{
"title": "Google People",
"file": "../docs/connectors/google-people.md"
},
{
"title": "Google Sheets",
"file": "../docs/connectors/google-sheets.md"
},
{
"title": "Google Slides",
"file": "../docs/connectors/google-slides.md"
},
{
"title": "Google Workspace",
"file": "../docs/connectors/google-workspace.md"
},
{
"title": "Google Workspace Search",
"file": "../docs/connectors/google-workspace-search.md"
},
{
"title": "Grok",
"file": "../docs/connectors/xai.md"
},
{
"title": "GSC Wizard",
"file": "../docs/connectors/gsc-wizard.md"
},
{
"title": "Honcho",
"file": "../docs/connectors/honcho.md"
},
{
"title": "Hugging Face",
"file": "../docs/connectors/hugging-face.md"
},
{
"title": "iMessage Photon",
"file": "../docs/connectors/imessage-photon.md"
},
{
"title": "Jira",
"file": "../docs/connectors/jira.md"
},
{
"title": "Linear",
"file": "../docs/connectors/linear.md"
},
{
"title": "Make",
"file": "../docs/connectors/make.md"
},
{
"title": "Mem0",
"file": "../docs/connectors/mem0.md"
},
{
"title": "Microsoft Teams",
"file": "../docs/connectors/microsoft-teams.md"
},
{
"title": "Miro",
"file": "../docs/connectors/miro.md"
},
{
"title": "Mixpanel",
"file": "../docs/connectors/mixpanel.md"
},
{
"title": "Neon",
"file": "../docs/connectors/neon.md"
},
{
"title": "Netlify",
"file": "../docs/connectors/netlify.md"
},
{
"title": "Notion",
"file": "../docs/connectors/notion.md"
},
{
"title": "OpenAI",
"file": "../docs/connectors/openai.md"
},
{
"title": "OpenRouter",
"file": "../docs/connectors/openrouter.md"
},
{
"title": "PagerDuty",
"file": "../docs/connectors/pagerduty.md"
},
{
"title": "Parallel Search",
"file": "../docs/connectors/parallel-search.md"
},
{
"title": "PostHog",
"file": "../docs/connectors/posthog.md"
},
{
"title": "Postman",
"file": "../docs/connectors/postman.md"
},
{
"title": "Railway",
"file": "../docs/connectors/railway.md"
},
{
"title": "Resend",
"file": "../docs/connectors/resend.md"
},
{
"title": "Sentry",
"file": "../docs/connectors/sentry.md"
},
{
"title": "Shopify",
"file": "../docs/connectors/shopify.md"
},
{
"title": "Slack",
"file": "../docs/connectors/slack.md"
},
{
"title": "Speko",
"file": "../docs/connectors/speko.md"
},
{
"title": "Stripe",
"file": "../docs/connectors/stripe.md"
},
{
"title": "Supabase",
"file": "../docs/connectors/supabase.md"
},
{
"title": "Superagent",
"file": "../docs/connectors/superagent.md"
},
{
"title": "Supermemory",
"file": "../docs/connectors/supermemory.md"
},
{
"title": "Tavily",
"file": "../docs/connectors/tavily.md"
},
{
"title": "Telegram",
"file": "../docs/connectors/telegram.md"
},
{
"title": "Telem.AI",
"file": "../docs/connectors/telem.md"
},
{
"title": "Todoist",
"file": "../docs/connectors/todoist.md"
},
{
"title": "Unikraft",
"file": "../docs/connectors/unikraft.md"
},
{
"title": "Webflow",
"file": "../docs/connectors/webflow.md"
},
{
"title": "Windsor.ai",
"file": "../docs/connectors/windsor-ai.md"
},
{
"title": "Wix",
"file": "../docs/connectors/wix.md"
},
{
"title": "You.com",
"file": "../docs/connectors/youcom.md"
},
{
"title": "Zapier",
"file": "../docs/connectors/zapier.md"
},
{
"title": "Zep",
"file": "../docs/connectors/zep.md"
}
]
}
]
},
{
"tier": "Learn",
"title": "Projects & Workflow",
"icon": "kanban-square",
"desc": "Projects, goals, routines, and execution workspaces.",
"pages": [
{
"title": "Projects",
"file": "../docs/guides/projects-workflow/projects.md"
},
{
"title": "Goals",
"file": "../docs/guides/projects-workflow/goals.md"
},
{
"title": "Heartbeats & Routines",
"file": "../docs/guides/projects-workflow/routines.md"
},
{
"title": "Execution Workspaces",
"file": "../docs/guides/projects-workflow/workspaces.md"
},
{
"title": "Custom Sandbox Images",
"file": "../docs/guides/projects-workflow/custom-sandbox-images.md"
},
{
"title": "Task Watchdogs",
"file": "../docs/guides/projects-workflow/task-watchdogs.md"
}
]
},
{
"tier": "Learn",
"title": "Power Features",
"icon": "settings-2",
"desc": "Execution policies, export/import, and terminal setup for power users.",
"pages": [
{
"title": "Execution Policy",
"file": "../docs/guides/power/execution-policy.md"
},
{
"title": "Export & Import",
"file": "../docs/guides/power/export-import.md"
},
{
"title": "Terminal Setup",
"file": "../docs/guides/power/terminal-setup.md"
}
]
},
{
"tier": "Learn",
"title": "Experimental",
"icon": "flask-conical",
"desc": "Opt-in features that ship behind flags — what each one does, why it exists, and how to turn it on.",
"pages": [
{
"title": "Overview",
"file": "../docs/experimental/overview.md"
},
{
"title": "Connections v3 (Apps)",
"file": "../docs/experimental/connections-apps.md"
},
{
"title": "Environments",
"file": "../docs/experimental/environments.md"
},
{
"title": "Isolated Workspaces",
"file": "../docs/experimental/isolated-workspaces.md"
},
{
"title": "Experimental File Viewer",
"file": "../docs/experimental/file-viewer.md"
},
{
"title": "External Objects",
"file": "../docs/experimental/external-objects.md"
},
{
"title": "Task Plan Decomposition",
"file": "../docs/experimental/plan-decomposition-panel.md"
},
{
"title": "Agent Chat",
"file": "../docs/experimental/agent-chat.md"
},
{
"title": "Assistant Connections (MCP)",
"file": "../docs/experimental/assistant-connections.md"
},
{
"title": "External Agents (Dot, Grok Bot, Muse)",
"file": "../docs/experimental/external-agents.md"
},
{
"title": "Task-Pinned AI Routing",
"file": "../docs/experimental/task-pinned-ai-routing.md"
},
{
"title": "Chat-Style Tasks",
"file": "../docs/experimental/task-chat.md"
},
{
"title": "Cases",
"file": "../docs/experimental/cases.md"
},
{
"title": "Task Watchdogs",
"file": "../docs/experimental/task-watchdogs.md"
},
{
"title": "Status Cards",
"file": "../docs/experimental/status-cards.md"
},
{
"title": "Cloud Sync",
"file": "../docs/experimental/cloud-sync.md"
},
{
"title": "Server Info Debug View",
"file": "../docs/experimental/server-info-debug-view.md"
},
{
"title": "Auto-Restart Dev Server",
"file": "../docs/experimental/auto-restart-dev-server.md"
},
{
"title": "Auto-Create Recovery Tasks",
"file": "../docs/experimental/auto-create-recovery-tasks.md"
}
]
},
{
"tier": "Learn",
"title": "How-to Guides",
"icon": "wrench",
"desc": "Field-tested recipes for specific problems — short, copy-pasteable, current.",
"pages": [
{
"title": "Members & Access",
"pages": [
{
"title": "Enable Multi-User Login",
"file": "../docs/how-to/enable-multi-user-login.md"
},
{
"title": "Add a Human Teammate",
"file": "../docs/how-to/add-a-human-teammate.md"
},
{
"title": "Offboard a Member",
"file": "../docs/how-to/offboard-a-member.md"
}
]
},
{
"title": "Governance & Budget",
"pages": [
{
"title": "Set a Monthly Budget",
"file": "../docs/how-to/set-monthly-budget.md"
},
{
"title": "Require Approval Before Spend",
"file": "../docs/how-to/require-board-approval-before-spend.md"
},
{
"title": "Handle Board Approvals for Hires",
"file": "../docs/how-to/handle-board-approvals-for-hires.md"
}
]
},
{
"title": "Agents & Skills",
"pages": [
{
"title": "Bring Your Own Agent",
"file": "../docs/how-to/bring-your-own-agent.md"
},
{
"title": "Connect an Agent to GitHub",
"file": "../docs/how-to/connect-agent-to-github.md"
},
{
"title": "Add an MCP Server to an Agent",
"file": "../docs/how-to/add-mcp-server-to-agent.md"
},
{
"title": "Write a Company Skill",
"file": "../docs/how-to/write-a-company-skill.md"
}
]
},
{
"title": "Automation & Notifications",
"pages": [
{
"title": "Create a Daily Routine",
"file": "../docs/how-to/create-a-daily-routine.md"
},
{
"title": "Wire Slack/Discord Notifications",
"file": "../docs/how-to/wire-slack-discord-notifications.md"
}
]
},
{
"title": "Secrets & Providers",
"pages": [
{
"title": "Update or Rotate a Provider API Key",
"file": "../docs/how-to/rotate-provider-api-key.md"
},
{
"title": "Connect an AWS Secrets Manager Vault",
"file": "../docs/how-to/connect-aws-secrets-vault.md"
}
]
},
{
"title": "Deploy & Maintain",
"pages": [
{
"title": "Deploy to a VPS or Fly.io",
"file": "../docs/how-to/deploy-to-vps-or-fly.md"
},
{
"title": "Update Paperclip to the Latest Version",
"file": "../docs/how-to/update-paperclip.md"
},
{
"title": "Back Up and Restore a Company",
"file": "../docs/how-to/back-up-and-restore-a-company.md"
},
{
"title": "Debug a Stuck Heartbeat",
"file": "../docs/how-to/debug-stuck-heartbeat.md"
},
{
"title": "Sync to Cloud Upstream",
"file": "../docs/how-to/sync-to-cloud-upstream.md"
},
{
"title": "Develop a plugin locally",
"file": "../docs/how-to/develop-a-plugin-locally.md"
},
{
"title": "Community Desktop App (unofficial)",
"file": "../docs/how-to/community-desktop-app.md"
}
]
}
]
},
{
"tier": "Learn",
"title": "Administration",
"icon": "shield",
"desc": "Company settings, instance configuration, plugins, and CLI auth — for operators and admins.",
"pages": [
{
"title": "Company",
"file": "../docs/administration/company.md"
},
{
"title": "Roles & Permissions",
"file": "../docs/administration/roles-and-permissions.md"
},
{
"title": "Secret Scopes",
"file": "../docs/administration/secret-scopes.md"
},
{
"title": "Secret Folders",
"file": "../docs/administration/secret-folders.md"
},
{
"title": "Settings",
"file": "../docs/administration/settings.md"
},
{
"title": "Agent Complaints and Suggestions",
"file": "../docs/administration/agent-commentary.md"
},
{
"title": "Trust & Low-Trust Review",
"file": "../docs/administration/trust-and-low-trust-review.md"
},
{
"title": "Plugins",
"file": "../docs/administration/plugins.md"
},
{
"title": "CLI Auth",
"file": "../docs/administration/cli-auth.md"
}
]
},
{
"tier": "Reference",
"title": "API",
"icon": "braces",
"desc": "Every endpoint on the control plane: companies, agents, issues, approvals, costs.",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/api/overview.md"
},
{
"title": "Authentication",
"file": "../docs/reference/api/authentication.md"
},
{
"title": "Assistant MCP",
"file": "../docs/reference/api/assistant-mcp.md"
},
{
"title": "Companies",
"file": "../docs/reference/api/companies.md"
},
{
"title": "Agents",
"file": "../docs/reference/api/agents.md"
},
{
"title": "Built-in Agents",
"file": "../docs/reference/api/built-in-agents.md"
},
{
"title": "Issues",
"file": "../docs/reference/api/issues.md"
},
{
"title": "Cases",
"file": "../docs/reference/api/cases.md"
},
{
"title": "Attention",
"file": "../docs/reference/api/attention.md"
},
{
"title": "Decisions",
"file": "../docs/reference/api/decisions.md"
},
{
"title": "Checkbox Confirmations",
"file": "../docs/reference/api/checkbox-confirmations.md"
},
{
"title": "Approvals",
"file": "../docs/reference/api/approvals.md"
},
{
"title": "Goals & Projects",
"file": "../docs/reference/api/goals-and-projects.md"
},
{
"title": "Resource Memberships",
"file": "../docs/reference/api/resource-memberships.md"
},
{
"title": "Folders",
"file": "../docs/reference/api/folders.md"
},
{
"title": "Company Skill Policy",
"file": "../docs/reference/api/company-skill-policy.md"
},
{
"title": "Inbox Agent Policy",
"file": "../docs/reference/api/inbox-agent-policy.md"
},
{
"title": "Costs",
"file": "../docs/reference/api/costs.md"
},
{
"title": "Decision Models",
"file": "../docs/reference/api/decision-models.md"
},
{
"title": "Secrets",
"file": "../docs/reference/api/secrets.md"
},
{
"title": "Activity",
"file": "../docs/reference/api/activity.md"
},
{
"title": "Decision Training",
"file": "../docs/reference/api/decision-training.md"
},
{
"title": "Summary Slots",
"file": "../docs/reference/api/summary-slots.md"
},
{
"title": "Status Cards",
"file": "../docs/reference/api/status-cards.md"
},
{
"title": "Dashboard",
"file": "../docs/reference/api/dashboard.md"
},
{
"title": "Routines",
"file": "../docs/reference/api/routines.md"
},
{
"title": "Adapters",
"file": "../docs/reference/api/adapters.md"
},
{
"title": "Teams Catalog",
"file": "../docs/reference/api/teams-catalog.md"
},
{
"title": "Plugins",
"file": "../docs/reference/api/plugins.md"
},
{
"title": "Tool Gateway",
"file": "../docs/reference/api/tool-gateway.md"
},
{
"title": "Connection Intents API",
"file": "../docs/reference/api/connection-intents.md"
},
{
"title": "Instance Admin",
"file": "../docs/reference/api/instance-admin.md"
}
]
},
{
"tier": "Reference",
"title": "CLI",
"icon": "terminal",
"desc": "Complete command-line reference: local setup, identity, and every control-plane command family.",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/cli/overview.md"
},
{
"title": "Installing the CLI",
"file": "../docs/reference/cli/installation.md"
},
{
"title": "Common Options",
"file": "../docs/reference/cli/common-options.md"
},
{
"title": "Output & Scripting",
"file": "../docs/reference/cli/output-and-scripting.md"
},
{
"title": "Setup Commands",
"file": "../docs/reference/cli/setup-commands.md"
},
{
"title": "Runtime Setup",
"file": "../docs/reference/cli/runtime.md"
},
{
"title": "Test Drive",
"file": "../docs/reference/cli/test-drive.md"
},
{
"title": "Service",
"file": "../docs/reference/cli/service.md"
},
{
"title": "Dev Environments",
"file": "../docs/reference/cli/dev-environments.md"
},
{
"title": "Authentication & Tokens",
"file": "../docs/reference/cli/authentication.md"
},
{
"title": "Connect",
"file": "../docs/reference/cli/connect.md"
},
{
"title": "MCP",
"file": "../docs/reference/cli/mcp.md"
},
{
"title": "Token",
"file": "../docs/reference/cli/token.md"
},
{
"title": "Company",
"file": "../docs/reference/cli/company.md"
},
{
"title": "Project",
"file": "../docs/reference/cli/project.md"
},
{
"title": "Goal",
"file": "../docs/reference/cli/goal.md"
},
{
"title": "Issue",
"file": "../docs/reference/cli/issue.md"
},
{
"title": "Agent",
"file": "../docs/reference/cli/agent.md"
},
{
"title": "Managed Agent",
"file": "../docs/reference/cli/managed-agent.md"
},
{
"title": "Prompt",
"file": "../docs/reference/cli/prompt.md"
},
{
"title": "Run (Heartbeat)",
"file": "../docs/reference/cli/run.md"
},
{
"title": "Routine",
"file": "../docs/reference/cli/routine.md"
},
{
"title": "Adapter",
"file": "../docs/reference/cli/adapter.md"
},
{
"title": "Connections",
"file": "../docs/reference/cli/connections.md"
},
{
"title": "Approval",
"file": "../docs/reference/cli/approval.md"
},
{
"title": "Activity",
"file": "../docs/reference/cli/activity.md"
},
{
"title": "Dashboard",
"file": "../docs/reference/cli/dashboard.md"
},
{
"title": "Cost & Budget",
"file": "../docs/reference/cli/cost.md"
},
{
"title": "Workspace",
"file": "../docs/reference/cli/workspace.md"
},
{
"title": "Access & Admin",
"file": "../docs/reference/cli/access.md"
},
{
"title": "Skills",
"file": "../docs/reference/cli/skills.md"
},
{
"title": "Teams",
"file": "../docs/reference/cli/teams.md"
},
{
"title": "Secrets",
"file": "../docs/reference/cli/secrets.md"
},
{
"title": "Cloud",
"file": "../docs/reference/cli/cloud.md"
},
{
"title": "Plugin",
"file": "../docs/reference/cli/plugin.md"
},
{
"title": "Asset",
"file": "../docs/reference/cli/asset.md"
},
{
"title": "Feedback",
"file": "../docs/reference/cli/feedback.md"
}
]
},
{
"tier": "Reference",
"title": "Skills",
"icon": "book-open",
"desc": "Skill file shape, install pipeline, scoping, versioning, and troubleshooting.",
"pages": [
{
"title": "Skills Reference",
"file": "../docs/reference/skills.md"
},
{
"title": "Bundled",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/skills/bundled.md"
},
{
"title": "Docs",
"pages": [
{
"title": "Doc Maintenance",
"file": "../docs/reference/skills/bundled/docs/doc-maintenance.md"
}
]
},
{
"title": "Paperclip Operations",
"pages": [
{
"title": "Issue Triage",
"file": "../docs/reference/skills/bundled/paperclip-operations/issue-triage.md"
},
{
"title": "Status Card Query",
"file": "../docs/reference/skills/bundled/paperclip-operations/status-card-query.md"
},
{
"title": "Task Planning",
"file": "../docs/reference/skills/bundled/paperclip-operations/task-planning.md"
}
]
},
{
"title": "Product",
"pages": [
{
"title": "Wireframe",
"file": "../docs/reference/skills/bundled/product/wireframe.md"
}
]
},
{
"title": "Quality",
"pages": [
{
"title": "QA Acceptance",
"file": "../docs/reference/skills/bundled/quality/qa-acceptance.md"
}
]
},
{
"title": "Software Development",
"pages": [
{
"title": "GitHub PR Workflow",
"file": "../docs/reference/skills/bundled/software-development/github-pr-workflow.md"
}
]
}
]
},
{
"title": "Optional",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/skills/optional.md"
},
{
"title": "Browser",
"pages": [
{
"title": "Agent Browser",
"file": "../docs/reference/skills/optional/browser/agent-browser.md"
}
]
},
{
"title": "Content",
"pages": [
{
"title": "Release Announcement",
"file": "../docs/reference/skills/optional/content/release-announcement.md"
},
{
"title": "Simplified English",
"file": "../docs/reference/skills/optional/content/simplified-english.md"
}
]
},
{
"title": "Finance",
"pages": [
{
"title": "Ramp",
"file": "../docs/reference/skills/optional/finance/ramp.md"
}
]
},
{
"title": "Product",
"pages": [
{
"title": "Design Critique",
"file": "../docs/reference/skills/optional/product/design-critique.md"
}
]
},
{
"title": "Research",
"pages": [
{
"title": "Last30Days",
"file": "../docs/reference/skills/optional/research/last30days.md"
}
]
},
{
"title": "Software Development",
"pages": [
{
"title": "Prepare MCP Integration",
"file": "../docs/reference/skills/optional/software-development/prepare-mcp-integration.md"
}
]
}
]
}
]
},
{
"tier": "Reference",
"title": "Adapters",
"icon": "plug",
"desc": "Connect any agent runtime — Claude, Codex, Gemini, or your own HTTP service.",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/adapters/overview.md"
},
{
"title": "Paperclip Runner (Experimental)",
"file": "../docs/reference/adapters/paperclip-runner.md"
},
{
"title": "Claude Code",
"file": "../docs/reference/adapters/claude-code.md"
},
{
"title": "Codex",
"file": "../docs/reference/adapters/codex.md"
},
{
"title": "Gemini CLI",
"file": "../docs/reference/adapters/gemini-cli.md"
},
{
"title": "Cursor Local",
"file": "../docs/reference/adapters/cursor-local.md"
},
{
"title": "Cursor Cloud",
"file": "../docs/reference/adapters/cursor-cloud.md"
},
{
"title": "ACPX Local (retired)",
"file": "../docs/reference/adapters/acpx-local.md"
},
{
"title": "OpenCode",
"file": "../docs/reference/adapters/opencode.md"
},
{
"title": "Pi",
"file": "../docs/reference/adapters/pi.md"
},
{
"title": "Hermes",
"file": "../docs/reference/adapters/hermes.md"
},
{
"title": "Hermes Gateway",
"file": "../docs/reference/adapters/hermes-gateway.md"
},
{
"title": "Grok Local",
"file": "../docs/reference/adapters/grok-local.md"
},
{
"title": "Kimi Code",
"file": "../docs/reference/adapters/kimi-local.md"
},
{
"title": "OpenClaw Gateway",
"file": "../docs/reference/adapters/openclaw-gateway.md"
},
{
"title": "Process",
"file": "../docs/reference/adapters/process.md"
},
{
"title": "HTTP",
"file": "../docs/reference/adapters/http.md"
},
{
"title": "Sandbox Providers",
"file": "../docs/reference/adapters/sandbox-providers.md"
},
{
"title": "Modal",
"file": "../docs/reference/adapters/modal.md"
},
{
"title": "External Adapters",
"file": "../docs/reference/adapters/external-adapters.md"
},
{
"title": "Creating an Adapter",
"file": "../docs/reference/adapters/creating-an-adapter.md"
},
{
"title": "UI Parser Contract",
"file": "../docs/reference/adapters/adapter-ui-parser.md"
}
]
},
{
"tier": "Reference",
"title": "Plugins",
"icon": "puzzle",
"desc": "Plugin SDK reference for authors building Paperclip plugins.",
"pages": [
{
"title": "Plugin SDK",
"file": "../docs/reference/plugins/sdk.md"
},
{
"title": "LLM Wiki",
"file": "../docs/reference/plugins/llm-wiki.md"
},
{
"title": "Workspace Diff Viewer",
"file": "../docs/reference/plugins/workspace-diff.md"
}
]
},
{
"tier": "Reference",
"title": "Deployment",
"icon": "cloud",
"desc": "Run Paperclip on your laptop, in Docker, or on a server — with secrets and Tailscale.",
"pages": [
{
"title": "Overview",
"file": "../docs/reference/deploy/overview.md"
},
{
"title": "Deployment Modes",
"file": "../docs/reference/deploy/deployment-modes.md"
},
{
"title": "Local Development",
"file": "../docs/reference/deploy/local-development.md"
},
{
"title": "Docker",
"file": "../docs/reference/deploy/docker.md"
},
{
"title": "Database",
"file": "../docs/reference/deploy/database.md"
},
{
"title": "Storage",
"file": "../docs/reference/deploy/storage.md"
},
{
"title": "Secrets",
"file": "../docs/reference/deploy/secrets.md"
},
{
"title": "Environment Variables",
"file": "../docs/reference/deploy/environment-variables.md"
},
{
"title": "Set Up HTTPS",
"file": "../docs/reference/deploy/https.md"
},
{
"title": "Tailscale Private Access",
"file": "../docs/reference/deploy/tailscale-private-access.md"
},
{
"title": "Tailscale HTTPS Broker",
"file": "../docs/reference/deploy/tailscale-https-broker.md"
}
]
},
{
"tier": "Reference",
"title": "Changelog",
"icon": "history",
"desc": "What changed in these docs — pages added, rewritten, or expanded — with each documentation update.",
"pages": [
{
"title": "Docs",
"file": "../docs/reference/changelog.md"
}
]
}
]
}
Reference in new issue View Git Blame Copy Permalink