mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 11:20:42 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - The first-run experience (onboarding wizard) and the chat surfaces
(conference-room/board chat, task threads, composers) are the product's
front door — they decide whether a new operator understands "hire
agents, give them work, review results" in the first five minutes
> - Today those surfaces feel ticket-y and form-like: the wizard is a
static multi-step form that ends in an anticlimactic "Launch" screen,
the task composer and board chat behave differently from each other, and
agent-feed issue quicklooks misbehave (multiple flyouts open at once,
cards jump on hover)
> - We wanted to iterate toward a conversational, team-centric NUX — but
without risking the workflows of everyone already running Paperclip
> - This PR reworks the NUX behind a new default-OFF
`enableConferenceRoomChat` experimental flag: a capsule-motif onboarding
wizard that builds your team as you answer, a conference-room chat
surface, one shared ChatComposer across surfaces, brand-accurate status
chips, and feed-quicklook fixes — with the pre-existing UI
fork-and-frozen as `*Classic` components that flag-OFF users keep
> - The benefit is a complete, testable modern NUX that anyone can opt
into from Settings → Experimental, with zero default behavior change and
a clean path to either graduate or drop the experiment
## Linked Issues or Issue Description
No pre-existing GitHub issue — feature description per
`feature_request.yml`:
- **Problem / motivation:** Paperclip's onboarding wizard and chat
surfaces grew up as separate ticket-centric forms. New users get a
form-filling experience rather than the feeling of standing up a team;
the board chat and task threads use different composers with different
affordances; the agent feed's issue quicklook can stack multiple
popovers and shifts cards on hover.
- **Proposed solution:** A coherent NUX experiment behind one
experimental flag (`enableConferenceRoomChat`, Settings → Experimental,
default OFF): capsule onboarding wizard with an evolving team capsule,
conference-room chat, unified `ChatComposer`, team-centric copy, brand
status chips, quicklook single-flight fix. Flag-OFF users get the exact
pre-experiment UI via frozen `*Classic` forks, verified by an on/off
parity test matrix.
- **Alternatives considered:** (a) incremental unflagged restyling —
rejected: the changes interlock across surfaces and would drip risk into
every release; (b) a separate app shell / route for the new NUX —
rejected: too much divergence, the flag + classic-fork pattern keeps the
diff reviewable and reversible.
- **Roadmap alignment:** `ROADMAP.md` lists **CEO Chat** ("a
lighter-weight way to talk to leadership agents... should still resolve
to real work objects"). This experiment is groundwork in that direction
(conference-room chat resolves to issues/tasks via the same composer
used in task threads) and does not change the core task-and-comments
model.
Related PRs found in the dedup search (same area, none duplicate this
work — they target the classic wizard, which this PR intentionally
leaves intact and mergeable):
- #5385 — Coach-driven onboarding: conversational entry +
agent-companies package import
- #5378 — Onboarding wizard: reusable adapter picker + probe card
- #6636 — ui(onboarding): friendly error surface + retry for the wizard
- #7005 — fix(onboarding): explicitly await first-task wake
- #2616 — fix: restore workspace directory config in onboarding wizard
## What Changed
- **Experimental flag plumbing** — `enableConferenceRoomChat` in shared
types/validators, server instance-settings service + API, Settings →
Experimental card with explicit enable/disable copy
- **Onboarding wizard** — classic wizard forked and frozen
(`OnboardingWizardClassic`); flag-ON variant is a 5-step capsule wizard
with a persistent evolving `AgentCapsule` (gradient/glow motif),
team-centric reframed copy, and a typing-dots intro (hardened with
fake-timer tests)
- **Conference-room chat** — flag-ON board-chat surface with agent
bubble name/icon headers and copy/vote/timestamp action rows
(`AgentBubbleActionRow`)
- **Unified composer** — shared `ChatComposer` adopted across surfaces;
translucent surface + scroll-mask removal; "Agent mode"/"Plan mode"
relabels; no-assignee confirmation `AlertDialog` (new
`ui/alert-dialog.tsx` primitive); `@task` reference picker +
linkification in mentions
- **Agent feed** — single-flight issue-quicklook store (one popover at a
time), flyouts open to the left, removed hover translate-y jitter
- **Status chips** — brand-accurate task status chips behind the flag
(light/dark, 1px borders per paperclip.ing/brand)
- **Tests** — flag on/off parity matrix across IssueDetail,
NewIssueDialog, Sidebar, wizard, gate components; component tests for
all new pieces
- **Merge with `master`** — one conflict in
`ui/src/components/IssueChatThread.tsx`, resolved by keeping master's
new `AssigneeChip`/`HandoffWakeRow`/`RunStatusBadge` components inside
the flag-gated metadata-row chrome (details in commit `21a5642a`);
post-merge fixes: vitest 4 mock typing in `MarkdownEditor.test.tsx`,
flag hook made safe for provider-less mounts (master's new isolated
component tests)
- **Branch hygiene** — internal design wireframes/mockups stripped
before the PR (they live in the Paperclip issue threads)
- No user-facing documentation changes required: the flag is
intentionally experimental and self-described in the Settings card; no
existing docs reference the affected surfaces
## Verification
- `pnpm run typecheck` — green across the workspace (ui, server, shared,
plugins)
- Full UI suite (`vitest run` in `ui/`, clean worktree at this HEAD):
**1593/1595 passing, 223/224 files** — the 2 remaining failures are in
`src/components/artifacts/ArtifactCard.test.tsx` and **fail identically
on pristine `origin/master`** (pre-existing upstream, unrelated to this
branch)
- Full server suite (`vitest run` in `server/`, same clean worktree):
results in PR checks; flag plumbing covered by instance-settings tests
- Targeted post-merge resolution check: `IssueChatThread`,
`IssueChatThreadSystemNotice`, `IssueDetail`, `Sidebar`,
`ConferenceRoomChatGate`, `OnboardingWizardVariant`, `NewIssueDialog`,
`InstanceExperimentalSettings`, `MarkdownEditor` — 172/172 passing
- Manual walkthrough: flag OFF (default) → onboarding wizard, task
thread, board chat, composer all render the classic UI; flag ON via
Settings → Experimental → capsule wizard, conference-room chat, unified
composer, status chips active
- Screenshots: see below
**Flag on/off screenshots** (committed on this branch under
`screenshots/PR-8000-*`):
| Surface | Flag OFF (classic, default) | Flag ON (experimental) |
| --- | --- | --- |
| Settings → Experimental | 
| 
|
| Task thread | 
| 
|
| Home / nav | 
| 
|
| Conference Room (flag-ON only surface) | — | 
|
Capsule onboarding wizard walkthrough screenshots (flag ON) are attached
to the Paperclip design/implementation threads; the wizard requires a
fresh instance so it is captured via the e2e harness
(`tests/e2e/nux-phase4-screenshots.spec.ts`).
## Risks
- **Large surface, but gated:** all new behavior sits behind
`enableConferenceRoomChat`, default OFF; flag-OFF rendering is locked by
frozen `*Classic` forks plus an on/off parity test suite
- **Classic forks are frozen at the fork point (`e3aada1d`):** master
features added to the live thread component after that point (assignee
handoff chips, run status badge, composer mention coach) render in the
flag-ON path; the flag-OFF task thread keeps the fork-point behavior
until the experiment graduates (forks deleted) or is dropped (forks
restored as canonical). Called out for reviewer attention.
- **Merge-conflict resolution in `IssueChatThread.tsx`** (commit
`21a5642a`) deserves reviewer eyes: master's new handoff/run-status
components were kept; the base toast-style no-assignee flow remains
replaced by the AlertDialog flow introduced on this branch
- Schema/server changes are additive (one optional boolean instance
setting); no migrations of existing data
## Model Used
- Claude (Anthropic) via Claude Code running in the Paperclip agent
harness (agent: ClaudeCoder)
- Branch implemented across multiple agent sessions on Claude Opus-class
models with extended thinking + tool use (file edits, shell, Playwright
screenshots); merge/PR session model ID as reported by the harness:
`claude-fable-5` (Claude Code CLI)
- All code was agent-authored and board-reviewed through Paperclip issue
threads (plans, wireframes, confirmations) before merging
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes (none
required — experimental flag, self-documenting Settings card; noted
above)
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green (run 3 on `8af3041a`: all 16
gates SUCCESS, incl. e2e and all 4 serialized-suite shards)
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
(re-review verdict: Confidence 5/5, “Safe to merge”; all 4 round-1
findings fixed + confirmed resolved; both summary notes addressed in
`8af3041a`)
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
133 lines
5.1 KiB
TypeScript
133 lines
5.1 KiB
TypeScript
import * as React from "react";
|
||
|
||
import { cn } from "@/lib/utils";
|
||
|
||
/**
|
||
* AgentCapsule — the brand "capsule is the agent" motif (PAP-118).
|
||
*
|
||
* A single agent is drawn as a tall pill (proportion 1:≥2, radius 9999px)
|
||
* that moves through three states as the agent comes to life:
|
||
*
|
||
* - `slot` — dashed outline, gently pulsing. An empty agent slot.
|
||
* - `configured` — solid stroke. Agent named / model picked, not yet live.
|
||
* - `online` — brand agent-gradient liquid rises to fill the capsule,
|
||
* which then breathes with an online-pulse ring (green by
|
||
* default, or blue via `glow="blue"`).
|
||
*
|
||
* The three states are drawn as stacked layers (a dashed outline, a solid
|
||
* stroke, and the rising liquid) that cross-fade by opacity. Because
|
||
* `border-style` is not animatable, the dashed→solid morph is realized as the
|
||
* dashed layer fading out while the solid layer fades in — so the SAME capsule
|
||
* can evolve in place across a flow (PAP-125, Option 4 wizard).
|
||
*
|
||
* The fill gradient comes from the live brand agent tokens
|
||
* `--agent-Na` (top) → `--agent-Nb` (bottom); pick which one with `gradient`
|
||
* (1–10). Size is a preset (`sm` | `md` | `lg`) or an explicit pixel pair so
|
||
* the component is reusable app-wide. `prefers-reduced-motion` is honored in
|
||
* CSS — the liquid rise, layer cross-fade and both pulses are skipped and the
|
||
* final state is rendered statically.
|
||
*/
|
||
|
||
export type AgentCapsuleState = "slot" | "configured" | "online";
|
||
|
||
export type AgentCapsuleSizePreset = "sm" | "md" | "lg";
|
||
|
||
/** Online-pulse colour. `green` for app-wide reuse; `blue` for wizard step 5. */
|
||
export type AgentCapsuleGlow = "green" | "blue";
|
||
|
||
/** Number of brand agent-gradient token pairs defined in index.css. */
|
||
export const AGENT_GRADIENT_COUNT = 10;
|
||
|
||
const SIZE_PRESETS: Record<AgentCapsuleSizePreset, { width: number; height: number }> = {
|
||
sm: { width: 24, height: 60 },
|
||
md: { width: 34, height: 84 },
|
||
lg: { width: 46, height: 116 },
|
||
};
|
||
|
||
const STATE_ARIA: Record<AgentCapsuleState, string> = {
|
||
slot: "empty agent slot",
|
||
configured: "agent configured, offline",
|
||
online: "agent online",
|
||
};
|
||
|
||
export interface AgentCapsuleProps
|
||
extends Omit<React.HTMLAttributes<HTMLDivElement>, "color"> {
|
||
/** Lifecycle state of the agent the capsule represents. */
|
||
state: AgentCapsuleState;
|
||
/** Brand agent-gradient index (1–{@link AGENT_GRADIENT_COUNT}). Wraps if out of range. */
|
||
gradient?: number;
|
||
/** Size preset, or an explicit `{ width, height }` in pixels (keep height ≥ 2× width). */
|
||
size?: AgentCapsuleSizePreset | { width: number; height: number };
|
||
/** Online-pulse colour (only applies in the `online` state). Defaults to `green`. */
|
||
glow?: AgentCapsuleGlow;
|
||
/** Accessible label; defaults to a description of the state. */
|
||
"aria-label"?: string;
|
||
}
|
||
|
||
/** Normalize a (possibly out-of-range) gradient index to 1…AGENT_GRADIENT_COUNT. */
|
||
function normalizeGradient(gradient: number): number {
|
||
const n = Math.trunc(gradient);
|
||
return ((((n - 1) % AGENT_GRADIENT_COUNT) + AGENT_GRADIENT_COUNT) % AGENT_GRADIENT_COUNT) + 1;
|
||
}
|
||
|
||
export function AgentCapsule({
|
||
state,
|
||
gradient = 1,
|
||
size = "md",
|
||
glow = "green",
|
||
className,
|
||
style,
|
||
"aria-label": ariaLabel,
|
||
...rest
|
||
}: AgentCapsuleProps) {
|
||
const dims = typeof size === "string" ? SIZE_PRESETS[size] : size;
|
||
const idx = normalizeGradient(gradient);
|
||
const fill = `linear-gradient(to bottom, var(--agent-${idx}a), var(--agent-${idx}b))`;
|
||
|
||
return (
|
||
<div
|
||
role="img"
|
||
aria-label={ariaLabel ?? STATE_ARIA[state]}
|
||
data-state={state}
|
||
data-gradient={idx}
|
||
data-glow={glow}
|
||
className={cn(
|
||
"agent-cap relative isolate mx-auto overflow-hidden rounded-full bg-transparent",
|
||
state === "online" && (glow === "blue" ? "agent-cap-online-blue" : "agent-cap-online"),
|
||
className,
|
||
)}
|
||
style={{ width: dims.width, height: dims.height, ...style }}
|
||
{...rest}
|
||
>
|
||
{/* Dashed outline — an empty agent slot. Visible (and pulsing) only in
|
||
the slot state; cross-fades out as the capsule is configured. */}
|
||
<span
|
||
aria-hidden="true"
|
||
className={cn(
|
||
"agent-cap-dash agent-cap-layer pointer-events-none absolute inset-0 rounded-full border-2 border-dashed border-muted-foreground/60",
|
||
state === "slot" ? "agent-cap-slot opacity-100" : "opacity-0",
|
||
)}
|
||
/>
|
||
{/* Solid stroke — agent configured, not yet live. Cross-fades in on top
|
||
of the dashed layer, then out as the liquid rises. */}
|
||
<span
|
||
aria-hidden="true"
|
||
className={cn(
|
||
"agent-cap-stroke agent-cap-layer pointer-events-none absolute inset-0 rounded-full border-2 border-solid border-foreground/70",
|
||
state === "configured" ? "opacity-100" : "opacity-0",
|
||
)}
|
||
/>
|
||
{/* Brand-gradient liquid — rises to fill the capsule when online. */}
|
||
{state === "online" ? (
|
||
<span
|
||
aria-hidden="true"
|
||
className="agent-cap-liquid absolute inset-x-0 bottom-0 block h-full"
|
||
style={{ background: fill }}
|
||
/>
|
||
) : null}
|
||
</div>
|
||
);
|
||
}
|
||
|
||
export default AgentCapsule;
|