Long unbreakable inline code tokens (file paths, API routes, config
keys like <paperclipInstanceRoot>/skills/{companyId}/...) and tab bars
with many tabs (e.g. one per provider) widened the page past the
viewport on narrow screens, causing horizontal scroll — most visibly
on /reference/skills.
- Inline <code> now wraps long tokens (overflow-wrap:anywhere) while
block code in <pre> keeps its own horizontal scroll.
- #article and links wrap long words/URLs.
- .tabs-bar scrolls horizontally instead of overflowing the page;
tab buttons keep their width (matches the code-tabs variant).
Verified with headless Chromium across all 135 docs pages at 320px
and 375px viewports: no page exceeds the viewport width (0 overflow).
Co-Authored-By: Claude Opus 4.8 <[email protected]>
Practitioner-focused recipe for the company budget brake — copy-pasteable
cURL for caps and per-agent caps, alert configuration, billing-code
attribution, and an end-to-end verification flow that forces a 100% pause
and recovers from it. Closes PAP-1811.
Co-Authored-By: Paperclip <[email protected]>
- 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]>
Three side-by-side paths (OpenClaw invite, HTTP webhook, custom Python
script) with copy-pasteable examples, a tradeoffs table, and pointers to
the companion adapter references.
Closes PAP-1807. Companion example repo tracked in PAP-2578.
Co-Authored-By: Paperclip <[email protected]>
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]>
Introduces docs/reference/cli/commands.md — a single searchable
reference covering every paperclipai subcommand, flag, environment
variable, and exit code, plus five end-to-end example flows. Linked
into the Reference → CLI nav and cross-referenced from the CLI
overview. Resolves PAP-1794.
Co-Authored-By: Paperclip <[email protected]>
Two static-review findings from PAP-2514 applied:
- Rename to "Quickstart Path" (was "5-Minute Path"). The 5-minute claim
with a 15-minute table read as misleading; the title is now honest and
the 5-minute promise stays in the body where it can be qualified.
- Move installation out of the numbered path. Install is one-time setup;
the path proper is now three steps totaling ~5–11 min, which lines up
with the body's promise sentence. Drops the misleading "Desktop App
is faster if you're not a Node developer" line — Claude Code being a
separate prereq breaks that claim.
Co-Authored-By: Paperclip <[email protected]>
Cross-link the org/skills guide to the agents API surface so a reader
who wants to script skill assignment can find /skills/sync and the
desiredSkills hire-time pointer without having to reverse-engineer the
endpoint from the UI.
Refs PAP-2507, PAP-1819.
Co-Authored-By: Paperclip <[email protected]>
- 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]>
- 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]>
Sets explicit time expectations and links to the four-page first-run
sequence (install → company → agent → watching). Reduces nav friction
for first-time readers — the skeptical engineer can scan the path,
the times, and the end-state screenshot before committing to the full
flow.
Co-Authored-By: Paperclip <[email protected]>
- 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]>
