forked from farhoodlabs/paperclip
2de893f624
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The board UI is the main operator surface, so its component and workflow coverage needs to stay reviewable as the product grows. > - This branch adds Storybook as a dedicated UI reference surface for core Paperclip screens and interaction patterns. > - That work spans Storybook infrastructure, app-level provider wiring, and a large fixture set that can render real control-plane states without a live backend. > - The branch also expands coverage across agents, budgets, issues, chat, dialogs, navigation, projects, and data visualization so future UI changes have a concrete visual baseline. > - This pull request packages that Storybook work on top of the latest `master`, excludes the lockfile from the final diff per repo policy, and fixes one fixture contract drift caught during verification. > - The benefit is a single reviewable PR that adds broad UI documentation and regression-surfacing coverage without losing the existing branch work. ## What Changed - Added Storybook 10 wiring for the UI package, including root scripts, UI package scripts, Storybook config, preview wrappers, Tailwind entrypoints, and setup docs. - Added a large fixture-backed data source for Storybook so complex board states can render without a live server. - Added story suites covering foundations, status language, control-plane surfaces, overview, UX labs, agent management, budget and finance, forms and editors, issue management, navigation and layout, chat and comments, data visualization, dialogs and modals, and projects/goals/workspaces. - Adjusted several UI components for Storybook parity so dialogs, menus, keyboard shortcuts, budget markers, markdown editing, and related surfaces render correctly in isolation. - Rebasing work for PR assembly: replayed the branch onto current `master`, removed `pnpm-lock.yaml` from the final PR diff, and aligned the dashboard fixture with the current `DashboardSummary.runActivity` API contract. ## Verification - `pnpm --filter @paperclipai/ui typecheck` - `pnpm --filter @paperclipai/ui build-storybook` - Manual diff audit after rebase: verified the PR no longer includes `pnpm-lock.yaml` and now cleanly targets current `master`. - Before/after UI note: before this branch there was no dedicated Storybook surface for these Paperclip views; after this branch the local Storybook build includes the new overview and domain story suites in `ui/storybook-static`. ## Risks - Large static fixture files can drift from shared types as dashboard and UI contracts evolve; this PR already needed one fixture correction for `runActivity`. - Storybook bundle output includes some large chunks, so future growth may need chunking work if build performance becomes an issue. - Several component tweaks were made for isolated rendering parity, so reviewers should spot-check key board surfaces against the live app behavior. ## Model Used - OpenAI Codex, GPT-5-based coding agent in the Paperclip harness; exact serving model ID is not exposed in-runtime to the agent. - Tool-assisted workflow with terminal execution, git operations, local typecheck/build verification, and GitHub CLI PR creation. - Context window/reasoning mode not surfaced by the harness. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
111 lines
3.5 KiB
TypeScript
111 lines
3.5 KiB
TypeScript
import { Dialog, DialogContent, DialogHeader, DialogTitle } from "@/components/ui/dialog";
|
|
|
|
interface ShortcutEntry {
|
|
keys: string[];
|
|
label: string;
|
|
}
|
|
|
|
interface ShortcutSection {
|
|
title: string;
|
|
shortcuts: ShortcutEntry[];
|
|
}
|
|
|
|
const sections: ShortcutSection[] = [
|
|
{
|
|
title: "Inbox",
|
|
shortcuts: [
|
|
{ keys: ["j"], label: "Move down" },
|
|
{ keys: ["k"], label: "Move up" },
|
|
{ keys: ["Enter"], label: "Open selected item" },
|
|
{ keys: ["a"], label: "Archive item" },
|
|
{ keys: ["y"], label: "Archive item" },
|
|
{ keys: ["r"], label: "Mark as read" },
|
|
{ keys: ["U"], label: "Mark as unread" },
|
|
],
|
|
},
|
|
{
|
|
title: "Issue detail",
|
|
shortcuts: [
|
|
{ keys: ["y"], label: "Quick-archive back to inbox" },
|
|
{ keys: ["g", "i"], label: "Go to inbox" },
|
|
{ keys: ["g", "c"], label: "Focus comment composer" },
|
|
],
|
|
},
|
|
{
|
|
title: "Global",
|
|
shortcuts: [
|
|
{ keys: ["/"], label: "Search current page or quick search" },
|
|
{ keys: ["c"], label: "New issue" },
|
|
{ keys: ["["], label: "Toggle sidebar" },
|
|
{ keys: ["]"], label: "Toggle panel" },
|
|
{ keys: ["?"], label: "Show keyboard shortcuts" },
|
|
],
|
|
},
|
|
];
|
|
|
|
function KeyCap({ children }: { children: string }) {
|
|
return (
|
|
<kbd className="inline-flex h-6 min-w-6 items-center justify-center rounded border border-border bg-muted px-1.5 font-mono text-xs font-medium text-foreground shadow-[0_1px_0_1px_hsl(var(--border))]">
|
|
{children}
|
|
</kbd>
|
|
);
|
|
}
|
|
|
|
export function KeyboardShortcutsCheatsheetContent() {
|
|
return (
|
|
<>
|
|
<div className="divide-y divide-border border-t border-border">
|
|
{sections.map((section) => (
|
|
<div key={section.title} className="px-5 py-3">
|
|
<h3 className="mb-2 text-[11px] font-semibold uppercase tracking-wider text-muted-foreground">
|
|
{section.title}
|
|
</h3>
|
|
<div className="space-y-1.5">
|
|
{section.shortcuts.map((shortcut) => (
|
|
<div
|
|
key={shortcut.label + shortcut.keys.join()}
|
|
className="flex items-center justify-between gap-4"
|
|
>
|
|
<span className="text-sm text-foreground/90">{shortcut.label}</span>
|
|
<div className="flex items-center gap-1">
|
|
{shortcut.keys.map((key, i) => (
|
|
<span key={key} className="flex items-center gap-1">
|
|
{i > 0 && <span className="text-xs text-muted-foreground">then</span>}
|
|
<KeyCap>{key}</KeyCap>
|
|
</span>
|
|
))}
|
|
</div>
|
|
</div>
|
|
))}
|
|
</div>
|
|
</div>
|
|
))}
|
|
</div>
|
|
<div className="border-t border-border px-5 py-3">
|
|
<p className="text-xs text-muted-foreground">
|
|
Press <KeyCap>Esc</KeyCap> to close · Shortcuts are disabled in text fields
|
|
</p>
|
|
</div>
|
|
</>
|
|
);
|
|
}
|
|
|
|
export function KeyboardShortcutsCheatsheet({
|
|
open,
|
|
onOpenChange,
|
|
}: {
|
|
open: boolean;
|
|
onOpenChange: (open: boolean) => void;
|
|
}) {
|
|
return (
|
|
<Dialog open={open} onOpenChange={onOpenChange}>
|
|
<DialogContent className="sm:max-w-md gap-0 p-0 overflow-hidden" showCloseButton={false}>
|
|
<DialogHeader className="px-5 pt-5 pb-3">
|
|
<DialogTitle className="text-base">Keyboard shortcuts</DialogTitle>
|
|
</DialogHeader>
|
|
<KeyboardShortcutsCheatsheetContent />
|
|
</DialogContent>
|
|
</Dialog>
|
|
);
|
|
}
|