From 62f6157f43fbcab977b96f94fd3ba508e90707c4 Mon Sep 17 00:00:00 2001 From: Michael Freno Date: Tue, 31 Mar 2026 14:06:06 -0400 Subject: [PATCH] drop skills from here --- agents/senior-engineer/HEARTBEAT.md | 12 +- .../life/projects/rssuper/items.yaml | 49 ++ .../life/projects/rssuper/summary.md | 31 + check-identity.js | 50 ++ skills/adapt/SKILL.md | 198 ----- skills/animate/SKILL.md | 190 ----- skills/audit/SKILL.md | 128 ---- skills/bolder/SKILL.md | 132 ---- skills/clarify/SKILL.md | 179 ----- skills/colorize/SKILL.md | 158 ---- skills/create-agent-adapter/SKILL.md | 718 ------------------ skills/critique/SKILL.md | 118 --- skills/delight/SKILL.md | 317 -------- skills/distill/SKILL.md | 137 ---- skills/extract/SKILL.md | 94 --- skills/frontend-design/SKILL.md | 127 ---- .../reference/color-and-contrast.md | 132 ---- .../reference/interaction-design.md | 123 --- .../reference/motion-design.md | 99 --- .../reference/responsive-design.md | 114 --- .../reference/spatial-design.md | 100 --- .../frontend-design/reference/typography.md | 131 ---- .../frontend-design/reference/ux-writing.md | 107 --- skills/harden/SKILL.md | 357 --------- skills/normalize/SKILL.md | 67 -- skills/onboard/SKILL.md | 242 ------ skills/optimize/SKILL.md | 268 ------- skills/paperclip-create-agent/SKILL.md | 139 ---- .../references/api-reference.md | 95 --- skills/paperclip-create-plugin/SKILL.md | 101 --- skills/paperclip/SKILL.md | 291 ------- skills/paperclip/references/api-reference.md | 561 -------------- skills/para-memory-files/SKILL.md | 104 --- .../para-memory-files/references/schemas.md | 35 - skills/polish/SKILL.md | 201 ----- skills/pr-report/SKILL.md | 202 ----- .../pr-report/assets/html-report-starter.html | 426 ----------- skills/pr-report/references/style-guide.md | 149 ---- skills/quieter/SKILL.md | 118 --- skills/release-changelog/SKILL.md | 178 ----- skills/release/SKILL.md | 261 ------- skills/teach-impeccable/SKILL.md | 69 -- 42 files changed, 137 insertions(+), 7171 deletions(-) create mode 100644 agents/senior-engineer/life/projects/rssuper/items.yaml create mode 100644 agents/senior-engineer/life/projects/rssuper/summary.md create mode 100644 check-identity.js delete mode 100644 skills/adapt/SKILL.md delete mode 100644 skills/animate/SKILL.md delete mode 100644 skills/audit/SKILL.md delete mode 100644 skills/bolder/SKILL.md delete mode 100644 skills/clarify/SKILL.md delete mode 100644 skills/colorize/SKILL.md delete mode 100644 skills/create-agent-adapter/SKILL.md delete mode 100644 skills/critique/SKILL.md delete mode 100644 skills/delight/SKILL.md delete mode 100644 skills/distill/SKILL.md delete mode 100644 skills/extract/SKILL.md delete mode 100644 skills/frontend-design/SKILL.md delete mode 100644 skills/frontend-design/reference/color-and-contrast.md delete mode 100644 skills/frontend-design/reference/interaction-design.md delete mode 100644 skills/frontend-design/reference/motion-design.md delete mode 100644 skills/frontend-design/reference/responsive-design.md delete mode 100644 skills/frontend-design/reference/spatial-design.md delete mode 100644 skills/frontend-design/reference/typography.md delete mode 100644 skills/frontend-design/reference/ux-writing.md delete mode 100644 skills/harden/SKILL.md delete mode 100644 skills/normalize/SKILL.md delete mode 100644 skills/onboard/SKILL.md delete mode 100644 skills/optimize/SKILL.md delete mode 100644 skills/paperclip-create-agent/SKILL.md delete mode 100644 skills/paperclip-create-agent/references/api-reference.md delete mode 100644 skills/paperclip-create-plugin/SKILL.md delete mode 100644 skills/paperclip/SKILL.md delete mode 100644 skills/paperclip/references/api-reference.md delete mode 100644 skills/para-memory-files/SKILL.md delete mode 100644 skills/para-memory-files/references/schemas.md delete mode 100644 skills/polish/SKILL.md delete mode 100644 skills/pr-report/SKILL.md delete mode 100644 skills/pr-report/assets/html-report-starter.html delete mode 100644 skills/pr-report/references/style-guide.md delete mode 100644 skills/quieter/SKILL.md delete mode 100644 skills/release-changelog/SKILL.md delete mode 100644 skills/release/SKILL.md delete mode 100644 skills/teach-impeccable/SKILL.md diff --git a/agents/senior-engineer/HEARTBEAT.md b/agents/senior-engineer/HEARTBEAT.md index 439152066..4b8349ad1 100644 --- a/agents/senior-engineer/HEARTBEAT.md +++ b/agents/senior-engineer/HEARTBEAT.md @@ -10,6 +10,7 @@ The base url for the api is localhost:8087 - `GET /api/agents/me` -- confirm your id, role, and chainOfCommand. - Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`. +- Check `PAPERCLIP_API_URL` for API endpoint (default: http://localhost:3000) ## 2. Local Planning Check @@ -55,9 +56,9 @@ As a Senior Engineer, you own feature development: ### Passing Work to Code Reviewer When you complete work on an issue: -1. Mark the issue as `in_review` -2. Assign the issue to the Code Reviewer -3. Add a comment summarizing what was done and what files were touched +1. Mark the issue as `in_review` (do NOT assign to Code Reviewer) +2. Add a comment summarizing what was done and what files were touched +3. Security Reviewer will assign to Code Reviewer, then mark as `done` if no issues ## 7. Fact Extraction @@ -80,12 +81,13 @@ When you complete work on an issue: 2. Checkout the issue: `POST /api/issues/{id}/checkout` 3. Implement the feature/fix 4. Run tests and ensure code quality -5. Mark issue as `in_review` and assign to Code Reviewer +5. Mark issue as `in_review` (do NOT assign to Code Reviewer) 6. Add a comment with summary of changes +7. Security Reviewer will assign to Code Reviewer, then mark as `done` if no issues **Engineers in your team:** - Junior Engineer - works on defined tasks, learns from senior engineers - Founding Engineer - handles architecture and core systems **Review flow:** -- Engineer → Code Reviewer → Security Reviewer → Done +- Engineer → Security Reviewer → Code Reviewer → Done diff --git a/agents/senior-engineer/life/projects/rssuper/items.yaml b/agents/senior-engineer/life/projects/rssuper/items.yaml new file mode 100644 index 000000000..0a4093a47 --- /dev/null +++ b/agents/senior-engineer/life/projects/rssuper/items.yaml @@ -0,0 +1,49 @@ +- id: rssuper + name: Rssuper + type: project + status: active + description: Cross-platform RSS reader with Android, iOS, and Linux native implementations + started: 2026-03-30 + goal: Native business logic migration - implement platform-specific services and UI integration + priority: P1 + tasks: + - id: FRE-535 + title: iOS notification service + status: in_review + completed: true + - id: FRE-536 + title: Android notification service + status: in_review + completed: true + - id: FRE-531 + title: Linux background sync service + status: in_review + completed: true + - id: FRE-538 + title: iOS settings store + status: in_review + completed: true + - id: FRE-541 + title: iOS bookmark store + status: in_review + completed: true + - id: FRE-544 + title: iOS UI integration + status: in_review + completed: true + - id: FRE-545 + title: Android UI integration + status: blocked + blocked_by: + - FRE-531 + - native-business-logic-migration-16 + dependencies: + - task: native-business-logic-migration-16 + status: not_found + note: Task not found in Rssuper project, may be in different project + - task: native-business-logic-migration-17 + status: not_found + note: Task not found in Rssuper project + code_reviewer: f274248f + security_reviewer: 036d6925 + board_contact: f4390417 diff --git a/agents/senior-engineer/life/projects/rssuper/summary.md b/agents/senior-engineer/life/projects/rssuper/summary.md new file mode 100644 index 000000000..3b15f3050 --- /dev/null +++ b/agents/senior-engineer/life/projects/rssuper/summary.md @@ -0,0 +1,31 @@ +# Rssuper Project + +## Summary + +Rssuper is a cross-platform RSS reader application with native implementations for Android, iOS, and Linux. The project is currently in the native business logic migration phase, implementing platform-specific notification services, bookmark stores, and UI integration. + +## Status + +Active - Native Business Logic Migration + +## Key Tasks (2026-03-31) + +- FRE-535: iOS notification service (in_review) +- FRE-536: Android notification service (in_review) +- FRE-531: Linux background sync service (in_review) +- FRE-538: iOS settings store (in_review) +- FRE-541: iOS bookmark store (in_review) +- FRE-544: iOS UI integration (in_review) +- FRE-545: Android UI integration (blocked - waiting for dependency resolution) + +## Dependencies + +- Task 16 (native-business-logic-migration-16) is referenced in multiple tasks but not found in the Rssuper project +- Task 17 (native-business-logic-migration-17) is referenced in Linux background sync task but not found +- Cross-project dependencies need to be resolved by board + +## Related Issues + +- [FRE-535](/PAP/issues/FRE-535) - iOS notification service +- [FRE-536](/PAP/issues/FRE-536) - Android notification service +- [FRE-545](/PAP/issues/FRE-545) - Android UI integration diff --git a/check-identity.js b/check-identity.js new file mode 100644 index 000000000..e9512bc0e --- /dev/null +++ b/check-identity.js @@ -0,0 +1,50 @@ +const http = require('http'); + +const agentId = process.env.PAPERCLIP_AGENT_ID; +const apiKey = process.env.PAPERCLIP_API_KEY; +const apiUrl = process.env.PAPERCLIP_API_URL; +const runId = process.env.PAPERCLIP_RUN_ID; + +console.log('Agent ID:', agentId); +console.log('API URL:', apiUrl); +console.log('Run ID:', runId); + +if (!apiKey || !apiUrl) { + console.error('Missing environment variables'); + process.exit(1); +} + +async function fetchJson(url, options = {}) { + const request = http.request({ + hostname: new URL(url).hostname, + port: new URL(url).port, + path: new URL(url).pathname, + method: options.method || 'GET', + headers: { + 'Authorization': `Bearer ${apiKey}`, + 'X-Paperclip-Run-Id': runId, + ...options.headers + } + }, (response) => { + let data = ''; + response.on('data', chunk => data += chunk); + response.on('end', () => { + try { + console.log(JSON.stringify(JSON.parse(data), null, 2)); + } catch (e) { + console.log(data); + } + }); + }); + request.on('error', console.error); + request.end(); +} + +console.log('\n=== FETCHING AGENT IDENTITY ===\n'); +fetchJson(`${apiUrl}/api/agents/me`).catch(console.error); + +console.log('\n=== FETCHING INBOX-LITE ===\n'); +fetchJson(`${apiUrl}/api/agents/me/inbox-lite`).catch(console.error); + +console.log('\n=== FETCHING ALL ASSIGNED ISSUES ===\n'); +fetchJson(`${apiUrl}/api/companies/${apiKey.split('-')[0] || 'unknown'}/issues?assigneeAgentId=${agentId}&status=todo,in_progress,blocked`).catch(console.error); diff --git a/skills/adapt/SKILL.md b/skills/adapt/SKILL.md deleted file mode 100644 index 7e11509f7..000000000 --- a/skills/adapt/SKILL.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -name: adapt -description: Adapt designs to work across different screen sizes, devices, contexts, or platforms. Ensures consistent experience across varied environments. -user-invokable: true -args: - - name: target - description: The feature or component to adapt (optional) - required: false - - name: context - description: What to adapt for (mobile, tablet, desktop, print, email, etc.) - required: false ---- - -Adapt existing designs to work effectively across different contexts - different screen sizes, devices, platforms, or use cases. - -## Assess Adaptation Challenge - -Understand what needs adaptation and why: - -1. **Identify the source context**: - - What was it designed for originally? (Desktop web? Mobile app?) - - What assumptions were made? (Large screen? Mouse input? Fast connection?) - - What works well in current context? - -2. **Understand target context**: - - **Device**: Mobile, tablet, desktop, TV, watch, print? - - **Input method**: Touch, mouse, keyboard, voice, gamepad? - - **Screen constraints**: Size, resolution, orientation? - - **Connection**: Fast wifi, slow 3G, offline? - - **Usage context**: On-the-go vs desk, quick glance vs focused reading? - - **User expectations**: What do users expect on this platform? - -3. **Identify adaptation challenges**: - - What won't fit? (Content, navigation, features) - - What won't work? (Hover states on touch, tiny touch targets) - - What's inappropriate? (Desktop patterns on mobile, mobile patterns on desktop) - -**CRITICAL**: Adaptation is not just scaling - it's rethinking the experience for the new context. - -## Plan Adaptation Strategy - -Create context-appropriate strategy: - -### Mobile Adaptation (Desktop → Mobile) - -**Layout Strategy**: -- Single column instead of multi-column -- Vertical stacking instead of side-by-side -- Full-width components instead of fixed widths -- Bottom navigation instead of top/side navigation - -**Interaction Strategy**: -- Touch targets 44x44px minimum (not hover-dependent) -- Swipe gestures where appropriate (lists, carousels) -- Bottom sheets instead of dropdowns -- Thumbs-first design (controls within thumb reach) -- Larger tap areas with more spacing - -**Content Strategy**: -- Progressive disclosure (don't show everything at once) -- Prioritize primary content (secondary content in tabs/accordions) -- Shorter text (more concise) -- Larger text (16px minimum) - -**Navigation Strategy**: -- Hamburger menu or bottom navigation -- Reduce navigation complexity -- Sticky headers for context -- Back button in navigation flow - -### Tablet Adaptation (Hybrid Approach) - -**Layout Strategy**: -- Two-column layouts (not single or three-column) -- Side panels for secondary content -- Master-detail views (list + detail) -- Adaptive based on orientation (portrait vs landscape) - -**Interaction Strategy**: -- Support both touch and pointer -- Touch targets 44x44px but allow denser layouts than phone -- Side navigation drawers -- Multi-column forms where appropriate - -### Desktop Adaptation (Mobile → Desktop) - -**Layout Strategy**: -- Multi-column layouts (use horizontal space) -- Side navigation always visible -- Multiple information panels simultaneously -- Fixed widths with max-width constraints (don't stretch to 4K) - -**Interaction Strategy**: -- Hover states for additional information -- Keyboard shortcuts -- Right-click context menus -- Drag and drop where helpful -- Multi-select with Shift/Cmd - -**Content Strategy**: -- Show more information upfront (less progressive disclosure) -- Data tables with many columns -- Richer visualizations -- More detailed descriptions - -### Print Adaptation (Screen → Print) - -**Layout Strategy**: -- Page breaks at logical points -- Remove navigation, footer, interactive elements -- Black and white (or limited color) -- Proper margins for binding - -**Content Strategy**: -- Expand shortened content (show full URLs, hidden sections) -- Add page numbers, headers, footers -- Include metadata (print date, page title) -- Convert charts to print-friendly versions - -### Email Adaptation (Web → Email) - -**Layout Strategy**: -- Narrow width (600px max) -- Single column only -- Inline CSS (no external stylesheets) -- Table-based layouts (for email client compatibility) - -**Interaction Strategy**: -- Large, obvious CTAs (buttons not text links) -- No hover states (not reliable) -- Deep links to web app for complex interactions - -## Implement Adaptations - -Apply changes systematically: - -### Responsive Breakpoints - -Choose appropriate breakpoints: -- Mobile: 320px-767px -- Tablet: 768px-1023px -- Desktop: 1024px+ -- Or content-driven breakpoints (where design breaks) - -### Layout Adaptation Techniques - -- **CSS Grid/Flexbox**: Reflow layouts automatically -- **Container Queries**: Adapt based on container, not viewport -- **`clamp()`**: Fluid sizing between min and max -- **Media queries**: Different styles for different contexts -- **Display properties**: Show/hide elements per context - -### Touch Adaptation - -- Increase touch target sizes (44x44px minimum) -- Add more spacing between interactive elements -- Remove hover-dependent interactions -- Add touch feedback (ripples, highlights) -- Consider thumb zones (easier to reach bottom than top) - -### Content Adaptation - -- Use `display: none` sparingly (still downloads) -- Progressive enhancement (core content first, enhancements on larger screens) -- Lazy loading for off-screen content -- Responsive images (`srcset`, `picture` element) - -### Navigation Adaptation - -- Transform complex nav to hamburger/drawer on mobile -- Bottom nav bar for mobile apps -- Persistent side navigation on desktop -- Breadcrumbs on smaller screens for context - -**IMPORTANT**: Test on real devices, not just browser DevTools. Device emulation is helpful but not perfect. - -**NEVER**: -- Hide core functionality on mobile (if it matters, make it work) -- Assume desktop = powerful device (consider accessibility, older machines) -- Use different information architecture across contexts (confusing) -- Break user expectations for platform (mobile users expect mobile patterns) -- Forget landscape orientation on mobile/tablet -- Use generic breakpoints blindly (use content-driven breakpoints) -- Ignore touch on desktop (many desktop devices have touch) - -## Verify Adaptations - -Test thoroughly across contexts: - -- **Real devices**: Test on actual phones, tablets, desktops -- **Different orientations**: Portrait and landscape -- **Different browsers**: Safari, Chrome, Firefox, Edge -- **Different OS**: iOS, Android, Windows, macOS -- **Different input methods**: Touch, mouse, keyboard -- **Edge cases**: Very small screens (320px), very large screens (4K) -- **Slow connections**: Test on throttled network - -Remember: You're a cross-platform design expert. Make experiences that feel native to each context while maintaining brand and functionality consistency. Adapt intentionally, test thoroughly. \ No newline at end of file diff --git a/skills/animate/SKILL.md b/skills/animate/SKILL.md deleted file mode 100644 index 5abd7435f..000000000 --- a/skills/animate/SKILL.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -name: animate -description: Review a feature and enhance it with purposeful animations, micro-interactions, and motion effects that improve usability and delight. -user-invokable: true -args: - - name: target - description: The feature or component to animate (optional) - required: false ---- - -Analyze a feature and strategically add animations and micro-interactions that enhance understanding, provide feedback, and create delight. - -## MANDATORY PREPARATION - -### Context Gathering (Do This First) - -You cannot do a great job without having necessary context, such as target audience (critical), desired use-cases (critical), brand personality/tone (playful vs serious, energetic vs calm), and performance constraints. - -Attempt to gather these from the current thread or codebase. - -1. If you don't find *exact* information and have to infer from existing design and functionality, you MUST STOP and STOP and call the AskUserQuestionTool to clarify. whether you got it right. -2. Otherwise, if you can't fully infer or your level of confidence is medium or lower, you MUST STOP and call the AskUserQuestionTool to clarify. clarifying questions first to complete your context. - -Do NOT proceed until you have answers. Guessing leads to inappropriate or excessive animation. - -### Use frontend-design skill - -Use the frontend-design skill for design principles and anti-patterns. Do NOT proceed until it has executed and you know all DO's and DON'Ts. - ---- - -## Assess Animation Opportunities - -Analyze where motion would improve the experience: - -1. **Identify static areas**: - - **Missing feedback**: Actions without visual acknowledgment (button clicks, form submission, etc.) - - **Jarring transitions**: Instant state changes that feel abrupt (show/hide, page loads, route changes) - - **Unclear relationships**: Spatial or hierarchical relationships that aren't obvious - - **Lack of delight**: Functional but joyless interactions - - **Missed guidance**: Opportunities to direct attention or explain behavior - -2. **Understand the context**: - - What's the personality? (Playful vs serious, energetic vs calm) - - What's the performance budget? (Mobile-first? Complex page?) - - Who's the audience? (Motion-sensitive users? Power users who want speed?) - - What matters most? (One hero animation vs many micro-interactions?) - -If any of these are unclear from the codebase, STOP and call the AskUserQuestionTool to clarify. - -**CRITICAL**: Respect `prefers-reduced-motion`. Always provide non-animated alternatives for users who need them. - -## Plan Animation Strategy - -Create a purposeful animation plan: - -- **Hero moment**: What's the ONE signature animation? (Page load? Hero section? Key interaction?) -- **Feedback layer**: Which interactions need acknowledgment? -- **Transition layer**: Which state changes need smoothing? -- **Delight layer**: Where can we surprise and delight? - -**IMPORTANT**: One well-orchestrated experience beats scattered animations everywhere. Focus on high-impact moments. - -## Implement Animations - -Add motion systematically across these categories: - -### Entrance Animations -- **Page load choreography**: Stagger element reveals (100-150ms delays), fade + slide combinations -- **Hero section**: Dramatic entrance for primary content (scale, parallax, or creative effects) -- **Content reveals**: Scroll-triggered animations using intersection observer -- **Modal/drawer entry**: Smooth slide + fade, backdrop fade, focus management - -### Micro-interactions -- **Button feedback**: - - Hover: Subtle scale (1.02-1.05), color shift, shadow increase - - Click: Quick scale down then up (0.95 → 1), ripple effect - - Loading: Spinner or pulse state -- **Form interactions**: - - Input focus: Border color transition, slight scale or glow - - Validation: Shake on error, check mark on success, smooth color transitions -- **Toggle switches**: Smooth slide + color transition (200-300ms) -- **Checkboxes/radio**: Check mark animation, ripple effect -- **Like/favorite**: Scale + rotation, particle effects, color transition - -### State Transitions -- **Show/hide**: Fade + slide (not instant), appropriate timing (200-300ms) -- **Expand/collapse**: Height transition with overflow handling, icon rotation -- **Loading states**: Skeleton screen fades, spinner animations, progress bars -- **Success/error**: Color transitions, icon animations, gentle scale pulse -- **Enable/disable**: Opacity transitions, cursor changes - -### Navigation & Flow -- **Page transitions**: Crossfade between routes, shared element transitions -- **Tab switching**: Slide indicator, content fade/slide -- **Carousel/slider**: Smooth transforms, snap points, momentum -- **Scroll effects**: Parallax layers, sticky headers with state changes, scroll progress indicators - -### Feedback & Guidance -- **Hover hints**: Tooltip fade-ins, cursor changes, element highlights -- **Drag & drop**: Lift effect (shadow + scale), drop zone highlights, smooth repositioning -- **Copy/paste**: Brief highlight flash on paste, "copied" confirmation -- **Focus flow**: Highlight path through form or workflow - -### Delight Moments -- **Empty states**: Subtle floating animations on illustrations -- **Completed actions**: Confetti, check mark flourish, success celebrations -- **Easter eggs**: Hidden interactions for discovery -- **Contextual animation**: Weather effects, time-of-day themes, seasonal touches - -## Technical Implementation - -Use appropriate techniques for each animation: - -### Timing & Easing - -**Durations by purpose:** -- **100-150ms**: Instant feedback (button press, toggle) -- **200-300ms**: State changes (hover, menu open) -- **300-500ms**: Layout changes (accordion, modal) -- **500-800ms**: Entrance animations (page load) - -**Easing curves (use these, not CSS defaults):** -```css -/* Recommended - natural deceleration */ ---ease-out-quart: cubic-bezier(0.25, 1, 0.5, 1); /* Smooth, refined */ ---ease-out-quint: cubic-bezier(0.22, 1, 0.36, 1); /* Slightly snappier */ ---ease-out-expo: cubic-bezier(0.16, 1, 0.3, 1); /* Confident, decisive */ - -/* AVOID - feel dated and tacky */ -/* bounce: cubic-bezier(0.34, 1.56, 0.64, 1); */ -/* elastic: cubic-bezier(0.68, -0.6, 0.32, 1.6); */ -``` - -**Exit animations are faster than entrances.** Use ~75% of enter duration. - -### CSS Animations -```css -/* Prefer for simple, declarative animations */ -- transitions for state changes -- @keyframes for complex sequences -- transform + opacity only (GPU-accelerated) -``` - -### JavaScript Animation -```javascript -/* Use for complex, interactive animations */ -- Web Animations API for programmatic control -- Framer Motion for React -- GSAP for complex sequences -``` - -### Performance -- **GPU acceleration**: Use `transform` and `opacity`, avoid layout properties -- **will-change**: Add sparingly for known expensive animations -- **Reduce paint**: Minimize repaints, use `contain` where appropriate -- **Monitor FPS**: Ensure 60fps on target devices - -### Accessibility -```css -@media (prefers-reduced-motion: reduce) { - * { - animation-duration: 0.01ms !important; - animation-iteration-count: 1 !important; - transition-duration: 0.01ms !important; - } -} -``` - -**NEVER**: -- Use bounce or elastic easing curves—they feel dated and draw attention to the animation itself -- Animate layout properties (width, height, top, left)—use transform instead -- Use durations over 500ms for feedback—it feels laggy -- Animate without purpose—every animation needs a reason -- Ignore `prefers-reduced-motion`—this is an accessibility violation -- Animate everything—animation fatigue makes interfaces feel exhausting -- Block interaction during animations unless intentional - -## Verify Quality - -Test animations thoroughly: - -- **Smooth at 60fps**: No jank on target devices -- **Feels natural**: Easing curves feel organic, not robotic -- **Appropriate timing**: Not too fast (jarring) or too slow (laggy) -- **Reduced motion works**: Animations disabled or simplified appropriately -- **Doesn't block**: Users can interact during/after animations -- **Adds value**: Makes interface clearer or more delightful - -Remember: Motion should enhance understanding and provide feedback, not just add decoration. Animate with purpose, respect performance constraints, and always consider accessibility. Great animation is invisible - it just makes everything feel right. \ No newline at end of file diff --git a/skills/audit/SKILL.md b/skills/audit/SKILL.md deleted file mode 100644 index e1ae379e2..000000000 --- a/skills/audit/SKILL.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -name: audit -description: Perform comprehensive audit of interface quality across accessibility, performance, theming, and responsive design. Generates detailed report of issues with severity ratings and recommendations. -user-invokable: true -args: - - name: area - description: The feature or area to audit (optional) - required: false ---- - -Run systematic quality checks and generate a comprehensive audit report with prioritized issues and actionable recommendations. Don't fix issues - document them for other commands to address. - -**First**: Use the frontend-design skill for design principles and anti-patterns. - -## Diagnostic Scan - -Run comprehensive checks across multiple dimensions: - -1. **Accessibility (A11y)** - Check for: - - **Contrast issues**: Text contrast ratios < 4.5:1 (or 7:1 for AAA) - - **Missing ARIA**: Interactive elements without proper roles, labels, or states - - **Keyboard navigation**: Missing focus indicators, illogical tab order, keyboard traps - - **Semantic HTML**: Improper heading hierarchy, missing landmarks, divs instead of buttons - - **Alt text**: Missing or poor image descriptions - - **Form issues**: Inputs without labels, poor error messaging, missing required indicators - -2. **Performance** - Check for: - - **Layout thrashing**: Reading/writing layout properties in loops - - **Expensive animations**: Animating layout properties (width, height, top, left) instead of transform/opacity - - **Missing optimization**: Images without lazy loading, unoptimized assets, missing will-change - - **Bundle size**: Unnecessary imports, unused dependencies - - **Render performance**: Unnecessary re-renders, missing memoization - -3. **Theming** - Check for: - - **Hard-coded colors**: Colors not using design tokens - - **Broken dark mode**: Missing dark mode variants, poor contrast in dark theme - - **Inconsistent tokens**: Using wrong tokens, mixing token types - - **Theme switching issues**: Values that don't update on theme change - -4. **Responsive Design** - Check for: - - **Fixed widths**: Hard-coded widths that break on mobile - - **Touch targets**: Interactive elements < 44x44px - - **Horizontal scroll**: Content overflow on narrow viewports - - **Text scaling**: Layouts that break when text size increases - - **Missing breakpoints**: No mobile/tablet variants - -5. **Anti-Patterns (CRITICAL)** - Check against ALL the **DON'T** guidelines in the frontend-design skill. Look for AI slop tells (AI color palette, gradient text, glassmorphism, hero metrics, card grids, generic fonts) and general design anti-patterns (gray on color, nested cards, bounce easing, redundant copy). - -**CRITICAL**: This is an audit, not a fix. Document issues thoroughly with clear explanations of impact. Use other commands (normalize, optimize, harden, etc.) to fix issues after audit. - -## Generate Comprehensive Report - -Create a detailed audit report with the following structure: - -### Anti-Patterns Verdict -**Start here.** Pass/fail: Does this look AI-generated? List specific tells from the skill's Anti-Patterns section. Be brutally honest. - -### Executive Summary -- Total issues found (count by severity) -- Most critical issues (top 3-5) -- Overall quality score (if applicable) -- Recommended next steps - -### Detailed Findings by Severity - -For each issue, document: -- **Location**: Where the issue occurs (component, file, line) -- **Severity**: Critical / High / Medium / Low -- **Category**: Accessibility / Performance / Theming / Responsive -- **Description**: What the issue is -- **Impact**: How it affects users -- **WCAG/Standard**: Which standard it violates (if applicable) -- **Recommendation**: How to fix it -- **Suggested command**: Which command to use (prefer: /animate, /quieter, /optimize, /adapt, /clarify, /distill, /delight, /onboard, /normalize, /audit, /harden, /polish, /extract, /bolder, /critique, /colorize — or other installed skills you're sure exist) - -#### Critical Issues -[Issues that block core functionality or violate WCAG A] - -#### High-Severity Issues -[Significant usability/accessibility impact, WCAG AA violations] - -#### Medium-Severity Issues -[Quality issues, WCAG AAA violations, performance concerns] - -#### Low-Severity Issues -[Minor inconsistencies, optimization opportunities] - -### Patterns & Systemic Issues - -Identify recurring problems: -- "Hard-coded colors appear in 15+ components, should use design tokens" -- "Touch targets consistently too small (<44px) throughout mobile experience" -- "Missing focus indicators on all custom interactive components" - -### Positive Findings - -Note what's working well: -- Good practices to maintain -- Exemplary implementations to replicate elsewhere - -### Recommendations by Priority - -Create actionable plan: -1. **Immediate**: Critical blockers to fix first -2. **Short-term**: High-severity issues (this sprint) -3. **Medium-term**: Quality improvements (next sprint) -4. **Long-term**: Nice-to-haves and optimizations - -### Suggested Commands for Fixes - -Map issues to available commands. Prefer these: /animate, /quieter, /optimize, /adapt, /clarify, /distill, /delight, /onboard, /normalize, /audit, /harden, /polish, /extract, /bolder, /critique, /colorize. You may also suggest other installed skills you're sure exist, but never invent commands. - -Examples: -- "Use `/normalize` to align with design system (addresses N theming issues)" -- "Use `/optimize` to improve performance (addresses N performance issues)" -- "Use `/harden` to improve resilience (addresses N edge cases)" - -**IMPORTANT**: Be thorough but actionable. Too many low-priority issues creates noise. Focus on what actually matters. - -**NEVER**: -- Report issues without explaining impact (why does this matter?) -- Mix severity levels inconsistently -- Skip positive findings (celebrate what works) -- Provide generic recommendations (be specific and actionable) -- Forget to prioritize (everything can't be critical) -- Report false positives without verification - -Remember: You're a quality auditor with exceptional attention to detail. Document systematically, prioritize ruthlessly, and provide clear paths to improvement. A good audit makes fixing easy. \ No newline at end of file diff --git a/skills/bolder/SKILL.md b/skills/bolder/SKILL.md deleted file mode 100644 index a13aa1bc6..000000000 --- a/skills/bolder/SKILL.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -name: bolder -description: Amplify safe or boring designs to make them more visually interesting and stimulating. Increases impact while maintaining usability. -user-invokable: true -args: - - name: target - description: The feature or component to make bolder (optional) - required: false ---- - -Increase visual impact and personality in designs that are too safe, generic, or visually underwhelming, creating more engaging and memorable experiences. - -## MANDATORY PREPARATION - -### Context Gathering (Do This First) - -You cannot do a great job without having necessary context, such as target audience (critical), desired use-cases (critical), brand personality/tone, and everything else that a great human designer would need as well. - -Attempt to gather these from the current thread or codebase. - -1. If you don't find *exact* information and have to infer from existing design and functionality, you MUST STOP and STOP and call the AskUserQuestionTool to clarify. whether you got it right. -2. Otherwise, if you can't fully infer or your level of confidence is medium or lower, you MUST STOP and call the AskUserQuestionTool to clarify. clarifying questions first to complete your context. - -Do NOT proceed until you have answers. Guessing leads to generic AI slop. - -### Use frontend-design skill - -Use the frontend-design skill for design principles and anti-patterns. Do NOT proceed until it has executed and you know all DO's and DON'Ts. - ---- - -## Assess Current State - -Analyze what makes the design feel too safe or boring: - -1. **Identify weakness sources**: - - **Generic choices**: System fonts, basic colors, standard layouts - - **Timid scale**: Everything is medium-sized with no drama - - **Low contrast**: Everything has similar visual weight - - **Static**: No motion, no energy, no life - - **Predictable**: Standard patterns with no surprises - - **Flat hierarchy**: Nothing stands out or commands attention - -2. **Understand the context**: - - What's the brand personality? (How far can we push?) - - What's the purpose? (Marketing can be bolder than financial dashboards) - - Who's the audience? (What will resonate?) - - What are the constraints? (Brand guidelines, accessibility, performance) - -If any of these are unclear from the codebase, STOP and call the AskUserQuestionTool to clarify. - -**CRITICAL**: "Bolder" doesn't mean chaotic or garish. It means distinctive, memorable, and confident. Think intentional drama, not random chaos. - -**WARNING - AI SLOP TRAP**: When making things "bolder," AI defaults to the same tired tricks: cyan/purple gradients, glassmorphism, neon accents on dark backgrounds, gradient text on metrics. These are the OPPOSITE of bold—they're generic. Review ALL the DON'T guidelines in the frontend-design skill before proceeding. Bold means distinctive, not "more effects." - -## Plan Amplification - -Create a strategy to increase impact while maintaining coherence: - -- **Focal point**: What should be the hero moment? (Pick ONE, make it amazing) -- **Personality direction**: Maximalist chaos? Elegant drama? Playful energy? Dark moody? Choose a lane. -- **Risk budget**: How experimental can we be? Push boundaries within constraints. -- **Hierarchy amplification**: Make big things BIGGER, small things smaller (increase contrast) - -**IMPORTANT**: Bold design must still be usable. Impact without function is just decoration. - -## Amplify the Design - -Systematically increase impact across these dimensions: - -### Typography Amplification -- **Replace generic fonts**: Swap system fonts for distinctive choices (see frontend-design skill for inspiration) -- **Extreme scale**: Create dramatic size jumps (3x-5x differences, not 1.5x) -- **Weight contrast**: Pair 900 weights with 200 weights, not 600 with 400 -- **Unexpected choices**: Variable fonts, display fonts for headlines, condensed/extended widths, monospace as intentional accent (not as lazy "dev tool" default) - -### Color Intensification -- **Increase saturation**: Shift to more vibrant, energetic colors (but not neon) -- **Bold palette**: Introduce unexpected color combinations—avoid the purple-blue gradient AI slop -- **Dominant color strategy**: Let one bold color own 60% of the design -- **Sharp accents**: High-contrast accent colors that pop -- **Tinted neutrals**: Replace pure grays with tinted grays that harmonize with your palette -- **Rich gradients**: Intentional multi-stop gradients (not generic purple-to-blue) - -### Spatial Drama -- **Extreme scale jumps**: Make important elements 3-5x larger than surroundings -- **Break the grid**: Let hero elements escape containers and cross boundaries -- **Asymmetric layouts**: Replace centered, balanced layouts with tension-filled asymmetry -- **Generous space**: Use white space dramatically (100-200px gaps, not 20-40px) -- **Overlap**: Layer elements intentionally for depth - -### Visual Effects -- **Dramatic shadows**: Large, soft shadows for elevation (but not generic drop shadows on rounded rectangles) -- **Background treatments**: Mesh patterns, noise textures, geometric patterns, intentional gradients (not purple-to-blue) -- **Texture & depth**: Grain, halftone, duotone, layered elements—NOT glassmorphism (it's overused AI slop) -- **Borders & frames**: Thick borders, decorative frames, custom shapes (not rounded rectangles with colored border on one side) -- **Custom elements**: Illustrative elements, custom icons, decorative details that reinforce brand - -### Motion & Animation -- **Entrance choreography**: Staggered, dramatic page load animations with 50-100ms delays -- **Scroll effects**: Parallax, reveal animations, scroll-triggered sequences -- **Micro-interactions**: Satisfying hover effects, click feedback, state changes -- **Transitions**: Smooth, noticeable transitions using ease-out-quart/quint/expo (not bounce or elastic—they cheapen the effect) - -### Composition Boldness -- **Hero moments**: Create clear focal points with dramatic treatment -- **Diagonal flows**: Escape horizontal/vertical rigidity with diagonal arrangements -- **Full-bleed elements**: Use full viewport width/height for impact -- **Unexpected proportions**: Golden ratio? Throw it out. Try 70/30, 80/20 splits - -**NEVER**: -- Add effects randomly without purpose (chaos ≠ bold) -- Sacrifice readability for aesthetics (body text must be readable) -- Make everything bold (then nothing is bold - need contrast) -- Ignore accessibility (bold design must still meet WCAG standards) -- Overwhelm with motion (animation fatigue is real) -- Copy trendy aesthetics blindly (bold means distinctive, not derivative) - -## Verify Quality - -Ensure amplification maintains usability and coherence: - -- **NOT AI slop**: Does this look like every other AI-generated "bold" design? If yes, start over. -- **Still functional**: Can users accomplish tasks without distraction? -- **Coherent**: Does everything feel intentional and unified? -- **Memorable**: Will users remember this experience? -- **Performant**: Do all these effects run smoothly? -- **Accessible**: Does it still meet accessibility standards? - -**The test**: If you showed this to someone and said "AI made this bolder," would they believe you immediately? If yes, you've failed. Bold means distinctive, not "more AI effects." - -Remember: Bold design is confident design. It takes risks, makes statements, and creates memorable experiences. But bold without strategy is just loud. Be intentional, be dramatic, be unforgettable. \ No newline at end of file diff --git a/skills/clarify/SKILL.md b/skills/clarify/SKILL.md deleted file mode 100644 index 4592a08de..000000000 --- a/skills/clarify/SKILL.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -name: clarify -description: Improve unclear UX copy, error messages, microcopy, labels, and instructions. Makes interfaces easier to understand and use. -user-invokable: true -args: - - name: target - description: The feature or component with unclear copy (optional) - required: false ---- - -Identify and improve unclear, confusing, or poorly written interface text to make the product easier to understand and use. - -## Assess Current Copy - -Identify what makes the text unclear or ineffective: - -1. **Find clarity problems**: - - **Jargon**: Technical terms users won't understand - - **Ambiguity**: Multiple interpretations possible - - **Passive voice**: "Your file has been uploaded" vs "We uploaded your file" - - **Length**: Too wordy or too terse - - **Assumptions**: Assuming user knowledge they don't have - - **Missing context**: Users don't know what to do or why - - **Tone mismatch**: Too formal, too casual, or inappropriate for situation - -2. **Understand the context**: - - Who's the audience? (Technical? General? First-time users?) - - What's the user's mental state? (Stressed during error? Confident during success?) - - What's the action? (What do we want users to do?) - - What's the constraint? (Character limits? Space limitations?) - -**CRITICAL**: Clear copy helps users succeed. Unclear copy creates frustration, errors, and support tickets. - -## Plan Copy Improvements - -Create a strategy for clearer communication: - -- **Primary message**: What's the ONE thing users need to know? -- **Action needed**: What should users do next (if anything)? -- **Tone**: How should this feel? (Helpful? Apologetic? Encouraging?) -- **Constraints**: Length limits, brand voice, localization considerations - -**IMPORTANT**: Good UX writing is invisible. Users should understand immediately without noticing the words. - -## Improve Copy Systematically - -Refine text across these common areas: - -### Error Messages -**Bad**: "Error 403: Forbidden" -**Good**: "You don't have permission to view this page. Contact your admin for access." - -**Bad**: "Invalid input" -**Good**: "Email addresses need an @ symbol. Try: name@example.com" - -**Principles**: -- Explain what went wrong in plain language -- Suggest how to fix it -- Don't blame the user -- Include examples when helpful -- Link to help/support if applicable - -### Form Labels & Instructions -**Bad**: "DOB (MM/DD/YYYY)" -**Good**: "Date of birth" (with placeholder showing format) - -**Bad**: "Enter value here" -**Good**: "Your email address" or "Company name" - -**Principles**: -- Use clear, specific labels (not generic placeholders) -- Show format expectations with examples -- Explain why you're asking (when not obvious) -- Put instructions before the field, not after -- Keep required field indicators clear - -### Button & CTA Text -**Bad**: "Click here" | "Submit" | "OK" -**Good**: "Create account" | "Save changes" | "Got it, thanks" - -**Principles**: -- Describe the action specifically -- Use active voice (verb + noun) -- Match user's mental model -- Be specific ("Save" is better than "OK") - -### Help Text & Tooltips -**Bad**: "This is the username field" -**Good**: "Choose a username. You can change this later in Settings." - -**Principles**: -- Add value (don't just repeat the label) -- Answer the implicit question ("What is this?" or "Why do you need this?") -- Keep it brief but complete -- Link to detailed docs if needed - -### Empty States -**Bad**: "No items" -**Good**: "No projects yet. Create your first project to get started." - -**Principles**: -- Explain why it's empty (if not obvious) -- Show next action clearly -- Make it welcoming, not dead-end - -### Success Messages -**Bad**: "Success" -**Good**: "Settings saved! Your changes will take effect immediately." - -**Principles**: -- Confirm what happened -- Explain what happens next (if relevant) -- Be brief but complete -- Match the user's emotional moment (celebrate big wins) - -### Loading States -**Bad**: "Loading..." (for 30+ seconds) -**Good**: "Analyzing your data... this usually takes 30-60 seconds" - -**Principles**: -- Set expectations (how long?) -- Explain what's happening (when it's not obvious) -- Show progress when possible -- Offer escape hatch if appropriate ("Cancel") - -### Confirmation Dialogs -**Bad**: "Are you sure?" -**Good**: "Delete 'Project Alpha'? This can't be undone." - -**Principles**: -- State the specific action -- Explain consequences (especially for destructive actions) -- Use clear button labels ("Delete project" not "Yes") -- Don't overuse confirmations (only for risky actions) - -### Navigation & Wayfinding -**Bad**: Generic labels like "Items" | "Things" | "Stuff" -**Good**: Specific labels like "Your projects" | "Team members" | "Settings" - -**Principles**: -- Be specific and descriptive -- Use language users understand (not internal jargon) -- Make hierarchy clear -- Consider information scent (breadcrumbs, current location) - -## Apply Clarity Principles - -Every piece of copy should follow these rules: - -1. **Be specific**: "Enter email" not "Enter value" -2. **Be concise**: Cut unnecessary words (but don't sacrifice clarity) -3. **Be active**: "Save changes" not "Changes will be saved" -4. **Be human**: "Oops, something went wrong" not "System error encountered" -5. **Be helpful**: Tell users what to do, not just what happened -6. **Be consistent**: Use same terms throughout (don't vary for variety) - -**NEVER**: -- Use jargon without explanation -- Blame users ("You made an error" → "This field is required") -- Be vague ("Something went wrong" without explanation) -- Use passive voice unnecessarily -- Write overly long explanations (be concise) -- Use humor for errors (be empathetic instead) -- Assume technical knowledge -- Vary terminology (pick one term and stick with it) -- Repeat information (headers restating intros, redundant explanations) -- Use placeholders as the only labels (they disappear when users type) - -## Verify Improvements - -Test that copy improvements work: - -- **Comprehension**: Can users understand without context? -- **Actionability**: Do users know what to do next? -- **Brevity**: Is it as short as possible while remaining clear? -- **Consistency**: Does it match terminology elsewhere? -- **Tone**: Is it appropriate for the situation? - -Remember: You're a clarity expert with excellent communication skills. Write like you're explaining to a smart friend who's unfamiliar with the product. Be clear, be helpful, be human. \ No newline at end of file diff --git a/skills/colorize/SKILL.md b/skills/colorize/SKILL.md deleted file mode 100644 index 05b15813a..000000000 --- a/skills/colorize/SKILL.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -name: colorize -description: Add strategic color to features that are too monochromatic or lack visual interest. Makes interfaces more engaging and expressive. -user-invokable: true -args: - - name: target - description: The feature or component to colorize (optional) - required: false ---- - -Strategically introduce color to designs that are too monochromatic, gray, or lacking in visual warmth and personality. - -## MANDATORY PREPARATION - -### Context Gathering (Do This First) - -You cannot do a great job without having necessary context, such as target audience (critical), desired use-cases (critical), brand personality/tone, and especially existing brand colors. - -Attempt to gather these from the current thread or codebase. - -1. If you don't find *exact* information and have to infer from existing design and functionality, you MUST STOP and STOP and call the AskUserQuestionTool to clarify. whether you got it right. -2. Otherwise, if you can't fully infer or your level of confidence is medium or lower, you MUST STOP and call the AskUserQuestionTool to clarify. clarifying questions first to complete your context. - -Do NOT proceed until you have answers. Guessing leads to generic AI slop colors. - -### Use frontend-design skill - -Use the frontend-design skill for design principles and anti-patterns. Do NOT proceed until it has executed and you know all DO's and DON'Ts. - ---- - -## Assess Color Opportunity - -Analyze the current state and identify opportunities: - -1. **Understand current state**: - - **Color absence**: Pure grayscale? Limited neutrals? One timid accent? - - **Missed opportunities**: Where could color add meaning, hierarchy, or delight? - - **Context**: What's appropriate for this domain and audience? - - **Brand**: Are there existing brand colors we should use? - -2. **Identify where color adds value**: - - **Semantic meaning**: Success (green), error (red), warning (yellow/orange), info (blue) - - **Hierarchy**: Drawing attention to important elements - - **Categorization**: Different sections, types, or states - - **Emotional tone**: Warmth, energy, trust, creativity - - **Wayfinding**: Helping users navigate and understand structure - - **Delight**: Moments of visual interest and personality - -If any of these are unclear from the codebase, STOP and call the AskUserQuestionTool to clarify. - -**CRITICAL**: More color ≠ better. Strategic color beats rainbow vomit every time. Every color should have a purpose. - -## Plan Color Strategy - -Create a purposeful color introduction plan: - -- **Color palette**: What colors match the brand/context? (Choose 2-4 colors max beyond neutrals) -- **Dominant color**: Which color owns 60% of colored elements? -- **Accent colors**: Which colors provide contrast and highlights? (30% and 10%) -- **Application strategy**: Where does each color appear and why? - -**IMPORTANT**: Color should enhance hierarchy and meaning, not create chaos. Less is more when it matters more. - -## Introduce Color Strategically - -Add color systematically across these dimensions: - -### Semantic Color -- **State indicators**: - - Success: Green tones (emerald, forest, mint) - - Error: Red/pink tones (rose, crimson, coral) - - Warning: Orange/amber tones - - Info: Blue tones (sky, ocean, indigo) - - Neutral: Gray/slate for inactive states - -- **Status badges**: Colored backgrounds or borders for states (active, pending, completed, etc.) -- **Progress indicators**: Colored bars, rings, or charts showing completion or health - -### Accent Color Application -- **Primary actions**: Color the most important buttons/CTAs -- **Links**: Add color to clickable text (maintain accessibility) -- **Icons**: Colorize key icons for recognition and personality -- **Headers/titles**: Add color to section headers or key labels -- **Hover states**: Introduce color on interaction - -### Background & Surfaces -- **Tinted backgrounds**: Replace pure gray (`#f5f5f5`) with warm neutrals (`oklch(97% 0.01 60)`) or cool tints (`oklch(97% 0.01 250)`) -- **Colored sections**: Use subtle background colors to separate areas -- **Gradient backgrounds**: Add depth with subtle, intentional gradients (not generic purple-blue) -- **Cards & surfaces**: Tint cards or surfaces slightly for warmth - -**Use OKLCH for color**: It's perceptually uniform, meaning equal steps in lightness *look* equal. Great for generating harmonious scales. - -### Data Visualization -- **Charts & graphs**: Use color to encode categories or values -- **Heatmaps**: Color intensity shows density or importance -- **Comparison**: Color coding for different datasets or timeframes - -### Borders & Accents -- **Accent borders**: Add colored left/top borders to cards or sections -- **Underlines**: Color underlines for emphasis or active states -- **Dividers**: Subtle colored dividers instead of gray lines -- **Focus rings**: Colored focus indicators matching brand - -### Typography Color -- **Colored headings**: Use brand colors for section headings (maintain contrast) -- **Highlight text**: Color for emphasis or categories -- **Labels & tags**: Small colored labels for metadata or categories - -### Decorative Elements -- **Illustrations**: Add colored illustrations or icons -- **Shapes**: Geometric shapes in brand colors as background elements -- **Gradients**: Colorful gradient overlays or mesh backgrounds -- **Blobs/organic shapes**: Soft colored shapes for visual interest - -## Balance & Refinement - -Ensure color addition improves rather than overwhelms: - -### Maintain Hierarchy -- **Dominant color** (60%): Primary brand color or most used accent -- **Secondary color** (30%): Supporting color for variety -- **Accent color** (10%): High contrast for key moments -- **Neutrals** (remaining): Gray/black/white for structure - -### Accessibility -- **Contrast ratios**: Ensure WCAG compliance (4.5:1 for text, 3:1 for UI components) -- **Don't rely on color alone**: Use icons, labels, or patterns alongside color -- **Test for color blindness**: Verify red/green combinations work for all users - -### Cohesion -- **Consistent palette**: Use colors from defined palette, not arbitrary choices -- **Systematic application**: Same color meanings throughout (green always = success) -- **Temperature consistency**: Warm palette stays warm, cool stays cool - -**NEVER**: -- Use every color in the rainbow (choose 2-4 colors beyond neutrals) -- Apply color randomly without semantic meaning -- Put gray text on colored backgrounds—it looks washed out; use a darker shade of the background color or transparency instead -- Use pure gray for neutrals—add subtle color tint (warm or cool) for sophistication -- Use pure black (`#000`) or pure white (`#fff`) for large areas -- Violate WCAG contrast requirements -- Use color as the only indicator (accessibility issue) -- Make everything colorful (defeats the purpose) -- Default to purple-blue gradients (AI slop aesthetic) - -## Verify Color Addition - -Test that colorization improves the experience: - -- **Better hierarchy**: Does color guide attention appropriately? -- **Clearer meaning**: Does color help users understand states/categories? -- **More engaging**: Does the interface feel warmer and more inviting? -- **Still accessible**: Do all color combinations meet WCAG standards? -- **Not overwhelming**: Is color balanced and purposeful? - -Remember: Color is emotional and powerful. Use it to create warmth, guide attention, communicate meaning, and express personality. But restraint and strategy matter more than saturation and variety. Be colorful, but be intentional. \ No newline at end of file diff --git a/skills/create-agent-adapter/SKILL.md b/skills/create-agent-adapter/SKILL.md deleted file mode 100644 index dcd6456ee..000000000 --- a/skills/create-agent-adapter/SKILL.md +++ /dev/null @@ -1,718 +0,0 @@ ---- -name: create-agent-adapter -description: > - Technical guide for creating a new Paperclip agent adapter. Use when building - a new adapter package, adding support for a new AI coding tool (e.g. a new - CLI agent, API-based agent, or custom process), or when modifying the adapter - system. Covers the required interfaces, module structure, registration points, - and conventions derived from the existing claude-local and codex-local adapters. ---- - -# Creating a Paperclip Agent Adapter - -An adapter bridges Paperclip's orchestration layer to a specific AI agent runtime (Claude Code, Codex CLI, a custom process, an HTTP endpoint, etc.). Each adapter is a self-contained package that provides implementations for **three consumers**: the server, the UI, and the CLI. - ---- - -## 1. Architecture Overview - -``` -packages/adapters// - src/ - index.ts # Shared metadata (type, label, models, agentConfigurationDoc) - server/ - index.ts # Server exports: execute, sessionCodec, parse helpers - execute.ts # Core execution logic (AdapterExecutionContext -> AdapterExecutionResult) - parse.ts # Stdout/result parsing for the agent's output format - ui/ - index.ts # UI exports: parseStdoutLine, buildConfig - parse-stdout.ts # Line-by-line stdout -> TranscriptEntry[] for the run viewer - build-config.ts # CreateConfigValues -> adapterConfig JSON for agent creation form - cli/ - index.ts # CLI exports: formatStdoutEvent - format-event.ts # Colored terminal output for `paperclipai run --watch` - package.json - tsconfig.json -``` - -Three separate registries consume adapter modules: - -| Registry | Location | Interface | -|----------|----------|-----------| -| Server | `server/src/adapters/registry.ts` | `ServerAdapterModule` | -| UI | `ui/src/adapters/registry.ts` | `UIAdapterModule` | -| CLI | `cli/src/adapters/registry.ts` | `CLIAdapterModule` | - ---- - -## 2. Shared Types (`@paperclipai/adapter-utils`) - -All adapter interfaces live in `packages/adapter-utils/src/types.ts`. Import from `@paperclipai/adapter-utils` (types) or `@paperclipai/adapter-utils/server-utils` (runtime helpers). - -### Core Interfaces - -```ts -// The execute function signature — every adapter must implement this -interface AdapterExecutionContext { - runId: string; - agent: AdapterAgent; // { id, companyId, name, adapterType, adapterConfig } - runtime: AdapterRuntime; // { sessionId, sessionParams, sessionDisplayId, taskKey } - config: Record; // The agent's adapterConfig blob - context: Record; // Runtime context (taskId, wakeReason, approvalId, etc.) - onLog: (stream: "stdout" | "stderr", chunk: string) => Promise; - onMeta?: (meta: AdapterInvocationMeta) => Promise; - authToken?: string; -} - -interface AdapterExecutionResult { - exitCode: number | null; - signal: string | null; - timedOut: boolean; - errorMessage?: string | null; - usage?: UsageSummary; // { inputTokens, outputTokens, cachedInputTokens? } - sessionId?: string | null; // Legacy — prefer sessionParams - sessionParams?: Record | null; // Opaque session state persisted between runs - sessionDisplayId?: string | null; - provider?: string | null; // "anthropic", "openai", etc. - model?: string | null; - costUsd?: number | null; - resultJson?: Record | null; - summary?: string | null; // Human-readable summary of what the agent did - clearSession?: boolean; // true = tell Paperclip to forget the stored session -} - -interface AdapterSessionCodec { - deserialize(raw: unknown): Record | null; - serialize(params: Record | null): Record | null; - getDisplayId?(params: Record | null): string | null; -} -``` - -### Module Interfaces - -```ts -// Server — registered in server/src/adapters/registry.ts -interface ServerAdapterModule { - type: string; - execute(ctx: AdapterExecutionContext): Promise; - testEnvironment(ctx: AdapterEnvironmentTestContext): Promise; - sessionCodec?: AdapterSessionCodec; - supportsLocalAgentJwt?: boolean; - models?: { id: string; label: string }[]; - agentConfigurationDoc?: string; -} - -// UI — registered in ui/src/adapters/registry.ts -interface UIAdapterModule { - type: string; - label: string; - parseStdoutLine: (line: string, ts: string) => TranscriptEntry[]; - ConfigFields: ComponentType; - buildAdapterConfig: (values: CreateConfigValues) => Record; -} - -// CLI — registered in cli/src/adapters/registry.ts -interface CLIAdapterModule { - type: string; - formatStdoutEvent: (line: string, debug: boolean) => void; -} -``` - ---- - -## 2.1 Adapter Environment Test Contract - -Every server adapter must implement `testEnvironment(...)`. This powers the board UI "Test environment" button in agent configuration. - -```ts -type AdapterEnvironmentCheckLevel = "info" | "warn" | "error"; -type AdapterEnvironmentTestStatus = "pass" | "warn" | "fail"; - -interface AdapterEnvironmentCheck { - code: string; - level: AdapterEnvironmentCheckLevel; - message: string; - detail?: string | null; - hint?: string | null; -} - -interface AdapterEnvironmentTestResult { - adapterType: string; - status: AdapterEnvironmentTestStatus; - checks: AdapterEnvironmentCheck[]; - testedAt: string; // ISO timestamp -} - -interface AdapterEnvironmentTestContext { - companyId: string; - adapterType: string; - config: Record; // runtime-resolved adapterConfig -} -``` - -Guidelines: - -- Return structured diagnostics, never throw for expected findings. -- Use `error` for invalid/unusable runtime setup (bad cwd, missing command, invalid URL). -- Use `warn` for non-blocking but important situations. -- Use `info` for successful checks and context. - -Severity policy is product-critical: warnings are not save blockers. -Example: for `claude_local`, detected `ANTHROPIC_API_KEY` must be a `warn`, not an `error`, because Claude can still run (it just uses API-key auth instead of subscription auth). - ---- - -## 3. Step-by-Step: Creating a New Adapter - -### 3.1 Create the Package - -``` -packages/adapters// - package.json - tsconfig.json - src/ - index.ts - server/index.ts - server/execute.ts - server/parse.ts - ui/index.ts - ui/parse-stdout.ts - ui/build-config.ts - cli/index.ts - cli/format-event.ts -``` - -**package.json** — must use the four-export convention: - -```json -{ - "name": "@paperclipai/adapter-", - "version": "0.0.1", - "private": true, - "type": "module", - "exports": { - ".": "./src/index.ts", - "./server": "./src/server/index.ts", - "./ui": "./src/ui/index.ts", - "./cli": "./src/cli/index.ts" - }, - "dependencies": { - "@paperclipai/adapter-utils": "workspace:*", - "picocolors": "^1.1.1" - }, - "devDependencies": { - "typescript": "^5.7.3" - } -} -``` - -### 3.2 Root `index.ts` — Adapter Metadata - -This file is imported by **all three** consumers (server, UI, CLI). Keep it dependency-free (no Node APIs, no React). - -```ts -export const type = "my_agent"; // snake_case, globally unique -export const label = "My Agent (local)"; - -export const models = [ - { id: "model-a", label: "Model A" }, - { id: "model-b", label: "Model B" }, -]; - -export const agentConfigurationDoc = `# my_agent agent configuration -...document all config fields here... -`; -``` - -**Required exports:** -- `type` — the adapter type key, stored in `agents.adapter_type` -- `label` — human-readable name for the UI -- `models` — available model options for the agent creation form -- `agentConfigurationDoc` — markdown describing all `adapterConfig` fields (used by LLM agents configuring other agents) - -**Writing `agentConfigurationDoc` as routing logic:** - -The `agentConfigurationDoc` is read by LLM agents (including Paperclip agents that create other agents). Write it as **routing logic**, not marketing copy. Include concrete "use when" and "don't use when" guidance so an LLM can decide whether this adapter is appropriate for a given task. - -```ts -export const agentConfigurationDoc = `# my_agent agent configuration - -Adapter: my_agent - -Use when: -- The agent needs to run MyAgent CLI locally on the host machine -- You need session persistence across runs (MyAgent supports thread resumption) -- The task requires MyAgent-specific tools (e.g. web search, code execution) - -Don't use when: -- You need a simple one-shot script execution (use the "process" adapter instead) -- The agent doesn't need conversational context between runs (process adapter is simpler) -- MyAgent CLI is not installed on the host - -Core fields: -- cwd (string, required): absolute working directory for the agent process -... -`; -``` - -Adding explicit negative cases improves adapter selection accuracy. One concrete anti-pattern is worth more than three paragraphs of description. - -### 3.3 Server Module - -#### `server/execute.ts` — The Core - -This is the most important file. It receives an `AdapterExecutionContext` and must return an `AdapterExecutionResult`. - -**Required behavior:** - -1. **Read config** — extract typed values from `ctx.config` using helpers (`asString`, `asNumber`, `asBoolean`, `asStringArray`, `parseObject` from `@paperclipai/adapter-utils/server-utils`) -2. **Build environment** — call `buildPaperclipEnv(agent)` then layer in `PAPERCLIP_RUN_ID`, context vars (`PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`, `PAPERCLIP_APPROVAL_ID`, `PAPERCLIP_APPROVAL_STATUS`, `PAPERCLIP_LINKED_ISSUE_IDS`), user env overrides, and auth token -3. **Resolve session** — check `runtime.sessionParams` / `runtime.sessionId` for an existing session; validate it's compatible (e.g. same cwd); decide whether to resume or start fresh -4. **Render prompt** — use `renderTemplate(template, data)` with the template variables: `agentId`, `companyId`, `runId`, `company`, `agent`, `run`, `context` -5. **Call onMeta** — emit adapter invocation metadata before spawning the process -6. **Spawn the process** — use `runChildProcess()` for CLI-based agents or `fetch()` for HTTP-based agents -7. **Parse output** — convert the agent's stdout into structured data (session id, usage, summary, errors) -8. **Handle session errors** — if resume fails with "unknown session", retry with a fresh session and set `clearSession: true` -9. **Return AdapterExecutionResult** — populate all fields the agent runtime supports - -**Environment variables the server always injects:** - -| Variable | Source | -|----------|--------| -| `PAPERCLIP_AGENT_ID` | `agent.id` | -| `PAPERCLIP_COMPANY_ID` | `agent.companyId` | -| `PAPERCLIP_API_URL` | Server's own URL | -| `PAPERCLIP_RUN_ID` | Current run id | -| `PAPERCLIP_TASK_ID` | `context.taskId` or `context.issueId` | -| `PAPERCLIP_WAKE_REASON` | `context.wakeReason` | -| `PAPERCLIP_WAKE_COMMENT_ID` | `context.wakeCommentId` or `context.commentId` | -| `PAPERCLIP_APPROVAL_ID` | `context.approvalId` | -| `PAPERCLIP_APPROVAL_STATUS` | `context.approvalStatus` | -| `PAPERCLIP_LINKED_ISSUE_IDS` | `context.issueIds` (comma-separated) | -| `PAPERCLIP_API_KEY` | `authToken` (if no explicit key in config) | - -#### `server/parse.ts` — Output Parser - -Parse the agent's stdout format into structured data. Must handle: - -- **Session identification** — extract session/thread ID from init events -- **Usage tracking** — extract token counts (input, output, cached) -- **Cost tracking** — extract cost if available -- **Summary extraction** — pull the agent's final text response -- **Error detection** — identify error states, extract error messages -- **Unknown session detection** — export an `isUnknownSessionError()` function for retry logic - -**Treat agent output as untrusted.** The stdout you're parsing comes from an LLM-driven process that may have executed arbitrary tool calls, fetched external content, or been influenced by prompt injection in the files it read. Parse defensively: -- Never `eval()` or dynamically execute anything from output -- Use safe extraction helpers (`asString`, `asNumber`, `parseJson`) — they return fallbacks on unexpected types -- Validate session IDs and other structured data before passing them through -- If output contains URLs, file paths, or commands, do not act on them in the adapter — just record them - -#### `server/index.ts` — Server Exports - -```ts -export { execute } from "./execute.js"; -export { testEnvironment } from "./test.js"; -export { parseMyAgentOutput, isMyAgentUnknownSessionError } from "./parse.js"; - -// Session codec — required for session persistence -export const sessionCodec: AdapterSessionCodec = { - deserialize(raw) { /* raw DB JSON -> typed params or null */ }, - serialize(params) { /* typed params -> JSON for DB storage */ }, - getDisplayId(params) { /* -> human-readable session id string */ }, -}; -``` - -#### `server/test.ts` — Environment Diagnostics - -Implement adapter-specific preflight checks used by the UI test button. - -Minimum expectations: - -1. Validate required config primitives (paths, commands, URLs, auth assumptions) -2. Return check objects with deterministic `code` values -3. Map severity consistently (`info` / `warn` / `error`) -4. Compute final status: - - `fail` if any `error` - - `warn` if no errors and at least one warning - - `pass` otherwise - -This operation should be lightweight and side-effect free. - -### 3.4 UI Module - -#### `ui/parse-stdout.ts` — Transcript Parser - -Converts individual stdout lines into `TranscriptEntry[]` for the run detail viewer. Must handle the agent's streaming output format and produce entries of these kinds: - -- `init` — model/session initialization -- `assistant` — agent text responses -- `thinking` — agent thinking/reasoning (if supported) -- `tool_call` — tool invocations with name and input -- `tool_result` — tool results with content and error flag -- `user` — user messages in the conversation -- `result` — final result with usage stats -- `stdout` — fallback for unparseable lines - -```ts -export function parseMyAgentStdoutLine(line: string, ts: string): TranscriptEntry[] { - // Parse JSON line, map to appropriate TranscriptEntry kind(s) - // Return [{ kind: "stdout", ts, text: line }] as fallback -} -``` - -#### `ui/build-config.ts` — Config Builder - -Converts the UI form's `CreateConfigValues` into the `adapterConfig` JSON blob stored on the agent. - -```ts -export function buildMyAgentConfig(v: CreateConfigValues): Record { - const ac: Record = {}; - if (v.cwd) ac.cwd = v.cwd; - if (v.promptTemplate) ac.promptTemplate = v.promptTemplate; - if (v.model) ac.model = v.model; - ac.timeoutSec = 0; - ac.graceSec = 15; - // ... adapter-specific fields - return ac; -} -``` - -#### UI Config Fields Component - -Create `ui/src/adapters//config-fields.tsx` with a React component implementing `AdapterConfigFieldsProps`. This renders adapter-specific form fields in the agent creation/edit form. - -Use the shared primitives from `ui/src/components/agent-config-primitives`: -- `Field` — labeled form field wrapper -- `ToggleField` — boolean toggle with label and hint -- `DraftInput` — text input with draft/commit behavior -- `DraftNumberInput` — number input with draft/commit behavior -- `help` — standard hint text for common fields - -The component must support both `create` mode (using `values`/`set`) and `edit` mode (using `config`/`eff`/`mark`). - -### 3.5 CLI Module - -#### `cli/format-event.ts` — Terminal Formatter - -Pretty-prints stdout lines for `paperclipai run --watch`. Use `picocolors` for coloring. - -```ts -import pc from "picocolors"; - -export function printMyAgentStreamEvent(raw: string, debug: boolean): void { - // Parse JSON line from agent stdout - // Print colored output: blue for system, green for assistant, yellow for tools - // In debug mode, print unrecognized lines in gray -} -``` - ---- - -## 4. Registration Checklist - -After creating the adapter package, register it in all three consumers: - -### 4.1 Server Registry (`server/src/adapters/registry.ts`) - -```ts -import { execute as myExecute, sessionCodec as mySessionCodec } from "@paperclipai/adapter-my-agent/server"; -import { agentConfigurationDoc as myDoc, models as myModels } from "@paperclipai/adapter-my-agent"; - -const myAgentAdapter: ServerAdapterModule = { - type: "my_agent", - execute: myExecute, - sessionCodec: mySessionCodec, - models: myModels, - supportsLocalAgentJwt: true, // true if agent can use Paperclip API - agentConfigurationDoc: myDoc, -}; - -// Add to the adaptersByType map -const adaptersByType = new Map( - [..., myAgentAdapter].map((a) => [a.type, a]), -); -``` - -### 4.2 UI Registry (`ui/src/adapters/registry.ts`) - -```ts -import { myAgentUIAdapter } from "./my-agent"; - -const adaptersByType = new Map( - [..., myAgentUIAdapter].map((a) => [a.type, a]), -); -``` - -With `ui/src/adapters/my-agent/index.ts`: - -```ts -import type { UIAdapterModule } from "../types"; -import { parseMyAgentStdoutLine } from "@paperclipai/adapter-my-agent/ui"; -import { MyAgentConfigFields } from "./config-fields"; -import { buildMyAgentConfig } from "@paperclipai/adapter-my-agent/ui"; - -export const myAgentUIAdapter: UIAdapterModule = { - type: "my_agent", - label: "My Agent", - parseStdoutLine: parseMyAgentStdoutLine, - ConfigFields: MyAgentConfigFields, - buildAdapterConfig: buildMyAgentConfig, -}; -``` - -### 4.3 CLI Registry (`cli/src/adapters/registry.ts`) - -```ts -import { printMyAgentStreamEvent } from "@paperclipai/adapter-my-agent/cli"; - -const myAgentCLIAdapter: CLIAdapterModule = { - type: "my_agent", - formatStdoutEvent: printMyAgentStreamEvent, -}; - -// Add to the adaptersByType map -``` - ---- - -## 5. Session Management — Designing for Long Runs - -Sessions allow agents to maintain conversation context across runs. The system is **codec-based** — each adapter defines how to serialize/deserialize its session state. - -**Design for long runs from the start.** Treat session reuse as the default primitive, not an optimization to add later. An agent working on an issue may be woken dozens of times — for the initial assignment, approval callbacks, re-assignments, manual nudges. Each wake should resume the existing conversation so the agent retains full context about what it has already done, what files it has read, and what decisions it has made. Starting fresh each time wastes tokens on re-reading the same files and risks contradictory decisions. - -**Key concepts:** -- `sessionParams` is an opaque `Record` stored in the DB per task -- The adapter's `sessionCodec.serialize()` converts execution result data to storable params -- `sessionCodec.deserialize()` converts stored params back for the next run -- `sessionCodec.getDisplayId()` extracts a human-readable session ID for the UI -- **cwd-aware resume**: if the session was created in a different cwd than the current config, skip resuming (prevents cross-project session contamination) -- **Unknown session retry**: if resume fails with a "session not found" error, retry with a fresh session and return `clearSession: true` so Paperclip wipes the stale session - -If the agent runtime supports any form of context compaction or conversation compression (e.g. Claude Code's automatic context management, or Codex's `previous_response_id` chaining), lean on it. Adapters that support session resume get compaction for free — the agent runtime handles context window management internally across resumes. - -**Pattern** (from both claude-local and codex-local): - -```ts -const canResumeSession = - runtimeSessionId.length > 0 && - (runtimeSessionCwd.length === 0 || path.resolve(runtimeSessionCwd) === path.resolve(cwd)); -const sessionId = canResumeSession ? runtimeSessionId : null; - -// ... run attempt ... - -// If resume failed with unknown session, retry fresh -if (sessionId && !proc.timedOut && exitCode !== 0 && isUnknownSessionError(output)) { - const retry = await runAttempt(null); - return toResult(retry, { clearSessionOnMissingSession: true }); -} -``` - ---- - -## 6. Server-Utils Helpers - -Import from `@paperclipai/adapter-utils/server-utils`: - -| Helper | Purpose | -|--------|---------| -| `asString(val, fallback)` | Safe string extraction | -| `asNumber(val, fallback)` | Safe number extraction | -| `asBoolean(val, fallback)` | Safe boolean extraction | -| `asStringArray(val)` | Safe string array extraction | -| `parseObject(val)` | Safe `Record` extraction | -| `parseJson(str)` | Safe JSON.parse returning `Record` or null | -| `renderTemplate(tmpl, data)` | `{{path.to.value}}` template rendering | -| `buildPaperclipEnv(agent)` | Standard `PAPERCLIP_*` env vars | -| `redactEnvForLogs(env)` | Redact sensitive keys for onMeta | -| `ensureAbsoluteDirectory(cwd)` | Validate cwd exists and is absolute | -| `ensureCommandResolvable(cmd, cwd, env)` | Validate command is in PATH | -| `ensurePathInEnv(env)` | Ensure PATH exists in env | -| `runChildProcess(runId, cmd, args, opts)` | Spawn with timeout, logging, capture | - ---- - -## 7. Conventions and Patterns - -### Naming -- Adapter type: `snake_case` (e.g. `claude_local`, `codex_local`) -- Package name: `@paperclipai/adapter-` -- Package directory: `packages/adapters//` - -### Config Parsing -- Never trust `config` values directly — always use `asString`, `asNumber`, etc. -- Provide sensible defaults for every optional field -- Document all fields in `agentConfigurationDoc` - -### Prompt Templates -- Support `promptTemplate` for every run -- Use `renderTemplate()` with the standard variable set -- Default prompt: `"You are agent {{agent.id}} ({{agent.name}}). Continue your Paperclip work."` - -### Error Handling -- Differentiate timeout vs process error vs parse failure -- Always populate `errorMessage` on failure -- Include raw stdout/stderr in `resultJson` when parsing fails -- Handle the agent CLI not being installed (command not found) - -### Logging -- Call `onLog("stdout", ...)` and `onLog("stderr", ...)` for all process output — this feeds the real-time run viewer -- Call `onMeta(...)` before spawning to record invocation details -- Use `redactEnvForLogs()` when including env in meta - -### Paperclip Skills Injection - -Paperclip ships shared skills (in the repo's top-level `skills/` directory) that agents need at runtime — things like the `paperclip` API skill and the `paperclip-create-agent` workflow skill. Each adapter is responsible for making these skills discoverable by its agent runtime **without polluting the agent's working directory**. - -**The constraint:** never copy or symlink skills into the agent's `cwd`. The cwd is the user's project checkout — writing `.claude/skills/` or any other files into it would contaminate the repo with Paperclip internals, break git status, and potentially leak into commits. - -**The pattern:** create a clean, isolated location for skills and tell the agent runtime to look there. - -**How claude-local does it:** - -1. At execution time, create a fresh tmpdir: `mkdtemp("paperclip-skills-")` -2. Inside it, create `.claude/skills/` (the directory structure Claude Code expects) -3. Symlink each skill directory from the repo's `skills/` into the tmpdir's `.claude/skills/` -4. Pass the tmpdir to Claude Code via `--add-dir ` — this makes Claude Code discover the skills as if they were registered in that directory, without touching the agent's actual cwd -5. Clean up the tmpdir in a `finally` block after the run completes - -```ts -// From claude-local execute.ts -async function buildSkillsDir(): Promise { - const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-skills-")); - const target = path.join(tmp, ".claude", "skills"); - await fs.mkdir(target, { recursive: true }); - const entries = await fs.readdir(PAPERCLIP_SKILLS_DIR, { withFileTypes: true }); - for (const entry of entries) { - if (entry.isDirectory()) { - await fs.symlink( - path.join(PAPERCLIP_SKILLS_DIR, entry.name), - path.join(target, entry.name), - ); - } - } - return tmp; -} - -// In execute(): pass --add-dir to Claude Code -const skillsDir = await buildSkillsDir(); -args.push("--add-dir", skillsDir); -// ... run process ... -// In finally: fs.rm(skillsDir, { recursive: true, force: true }) -``` - -**How codex-local does it:** - -Codex has a global personal skills directory (`$CODEX_HOME/skills` or `~/.codex/skills`). The adapter symlinks Paperclip skills there if they don't already exist. This is acceptable because it's the agent tool's own config directory, not the user's project. - -```ts -// From codex-local execute.ts -async function ensureCodexSkillsInjected(onLog) { - const skillsHome = path.join(codexHomeDir(), "skills"); - await fs.mkdir(skillsHome, { recursive: true }); - for (const entry of entries) { - const target = path.join(skillsHome, entry.name); - const existing = await fs.lstat(target).catch(() => null); - if (existing) continue; // Don't overwrite user's own skills - await fs.symlink(source, target); - } -} -``` - -**For a new adapter:** figure out how your agent runtime discovers skills/plugins, then choose the cleanest injection path: - -1. **Best: tmpdir + flag** (like claude-local) — if the runtime supports an "additional directory" flag, create a tmpdir, symlink skills in, pass the flag, clean up after. Zero side effects. -2. **Acceptable: global config dir** (like codex-local) — if the runtime has a global skills/plugins directory separate from the project, symlink there. Skip existing entries to avoid overwriting user customizations. -3. **Acceptable: env var** — if the runtime reads a skills/plugin path from an environment variable, point it at the repo's `skills/` directory directly. -4. **Last resort: prompt injection** — if the runtime has no plugin system, include skill content in the prompt template itself. This uses tokens but avoids filesystem side effects entirely. - -**Skills as loaded procedures, not prompt bloat.** The Paperclip skills (like `paperclip` and `paperclip-create-agent`) are designed as on-demand procedures: the agent sees skill metadata (name + description) in its context, but only loads the full SKILL.md content when it decides to invoke a skill. This keeps the base prompt small. When writing `agentConfigurationDoc` or prompt templates for your adapter, do not inline skill content — let the agent runtime's skill discovery do the work. The descriptions in each SKILL.md frontmatter act as routing logic: they tell the agent when to load the full skill, not what the skill contains. - -**Explicit vs. fuzzy skill invocation.** For production workflows where reliability matters (e.g. an agent that must always call the Paperclip API to report status), use explicit instructions in the prompt template: "Use the paperclip skill to report your progress." Fuzzy routing (letting the model decide based on description matching) is fine for exploratory tasks but unreliable for mandatory procedures. - ---- - -## 8. Security Considerations - -Adapters sit at the boundary between Paperclip's orchestration layer and arbitrary agent execution. This is a high-risk surface. - -### Treat Agent Output as Untrusted - -The agent process runs LLM-driven code that reads external files, fetches URLs, and executes tools. Its output may be influenced by prompt injection from the content it processes. The adapter's parse layer is a trust boundary — validate everything, execute nothing. - -### Secret Injection via Environment, Not Prompts - -Never put secrets (API keys, tokens) into prompt templates or config fields that flow through the LLM. Instead, inject them as environment variables that the agent's tools can read directly: - -- `PAPERCLIP_API_KEY` is injected by the server into the process environment, not the prompt -- User-provided secrets in `config.env` are passed as env vars, redacted in `onMeta` logs -- The `redactEnvForLogs()` helper automatically masks any key matching `/(key|token|secret|password|authorization|cookie)/i` - -This follows the "sidecar injection" pattern: the model never sees the real secret value, but the tools it invokes can read it from the environment. - -### Network Access - -If your agent runtime supports network access controls (sandboxing, allowlists), configure them in the adapter: - -- Prefer minimal allowlists over open internet access. An agent that only needs to call the Paperclip API and GitHub should not have access to arbitrary hosts. -- Skills + network = amplified risk. A skill that teaches the agent to make HTTP requests combined with unrestricted network access creates an exfiltration path. Constrain one or the other. -- If the runtime supports layered policies (org-level defaults + per-request overrides), wire the org-level policy into the adapter config and let per-agent config narrow further. - -### Process Isolation - -- CLI-based adapters inherit the server's user permissions. The `cwd` and `env` config determine what the agent process can access on the filesystem. -- `dangerouslySkipPermissions` / `dangerouslyBypassApprovalsAndSandbox` flags exist for development convenience but must be documented as dangerous in `agentConfigurationDoc`. Production deployments should not use them. -- Timeout and grace period (`timeoutSec`, `graceSec`) are safety rails — always enforce them. A runaway agent process without a timeout can consume unbounded resources. - ---- - -## 9. TranscriptEntry Kinds Reference - -The UI run viewer displays these entry kinds: - -| Kind | Fields | Usage | -|------|--------|-------| -| `init` | `model`, `sessionId` | Agent initialization | -| `assistant` | `text` | Agent text response | -| `thinking` | `text` | Agent reasoning/thinking | -| `user` | `text` | User message | -| `tool_call` | `name`, `input` | Tool invocation | -| `tool_result` | `toolUseId`, `content`, `isError` | Tool result | -| `result` | `text`, `inputTokens`, `outputTokens`, `cachedTokens`, `costUsd`, `subtype`, `isError`, `errors` | Final result with usage | -| `stderr` | `text` | Stderr output | -| `system` | `text` | System messages | -| `stdout` | `text` | Raw stdout fallback | - ---- - -## 10. Testing - -Create tests in `server/src/__tests__/-adapter.test.ts`. Test: - -1. **Output parsing** — feed sample stdout through your parser, verify structured output -2. **Unknown session detection** — verify the `isUnknownSessionError` function -3. **Config building** — verify `buildConfig` produces correct adapterConfig from form values -4. **Session codec** — verify serialize/deserialize round-trips - ---- - -## 11. Minimal Adapter Checklist - -- [ ] `packages/adapters//package.json` with four exports (`.`, `./server`, `./ui`, `./cli`) -- [ ] Root `index.ts` with `type`, `label`, `models`, `agentConfigurationDoc` -- [ ] `server/execute.ts` implementing `AdapterExecutionContext -> AdapterExecutionResult` -- [ ] `server/test.ts` implementing `AdapterEnvironmentTestContext -> AdapterEnvironmentTestResult` -- [ ] `server/parse.ts` with output parser and unknown-session detector -- [ ] `server/index.ts` exporting `execute`, `testEnvironment`, `sessionCodec`, parse helpers -- [ ] `ui/parse-stdout.ts` with `StdoutLineParser` for the run viewer -- [ ] `ui/build-config.ts` with `CreateConfigValues -> adapterConfig` builder -- [ ] `ui/src/adapters//config-fields.tsx` React component for agent form -- [ ] `ui/src/adapters//index.ts` assembling the `UIAdapterModule` -- [ ] `cli/format-event.ts` with terminal formatter -- [ ] `cli/index.ts` exporting the formatter -- [ ] Registered in `server/src/adapters/registry.ts` -- [ ] Registered in `ui/src/adapters/registry.ts` -- [ ] Registered in `cli/src/adapters/registry.ts` -- [ ] Added to workspace in root `pnpm-workspace.yaml` (if not already covered by glob) -- [ ] Tests for parsing, session codec, and config building diff --git a/skills/critique/SKILL.md b/skills/critique/SKILL.md deleted file mode 100644 index 7d3aefad4..000000000 --- a/skills/critique/SKILL.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -name: critique -description: Evaluate design effectiveness from a UX perspective. Assesses visual hierarchy, information architecture, emotional resonance, and overall design quality with actionable feedback. -user-invokable: true -args: - - name: area - description: The feature or area to critique (optional) - required: false ---- - -Conduct a holistic design critique, evaluating whether the interface actually works—not just technically, but as a designed experience. Think like a design director giving feedback. - -**First**: Use the frontend-design skill for design principles and anti-patterns. - -## Design Critique - -Evaluate the interface across these dimensions: - -### 1. AI Slop Detection (CRITICAL) - -**This is the most important check.** Does this look like every other AI-generated interface from 2024-2025? - -Review the design against ALL the **DON'T** guidelines in the frontend-design skill—they are the fingerprints of AI-generated work. Check for the AI color palette, gradient text, dark mode with glowing accents, glassmorphism, hero metric layouts, identical card grids, generic fonts, and all other tells. - -**The test**: If you showed this to someone and said "AI made this," would they believe you immediately? If yes, that's the problem. - -### 2. Visual Hierarchy -- Does the eye flow to the most important element first? -- Is there a clear primary action? Can you spot it in 2 seconds? -- Do size, color, and position communicate importance correctly? -- Is there visual competition between elements that should have different weights? - -### 3. Information Architecture -- Is the structure intuitive? Would a new user understand the organization? -- Is related content grouped logically? -- Are there too many choices at once? (cognitive overload) -- Is the navigation clear and predictable? - -### 4. Emotional Resonance -- What emotion does this interface evoke? Is that intentional? -- Does it match the brand personality? -- Does it feel trustworthy, approachable, premium, playful—whatever it should feel? -- Would the target user feel "this is for me"? - -### 5. Discoverability & Affordance -- Are interactive elements obviously interactive? -- Would a user know what to do without instructions? -- Are hover/focus states providing useful feedback? -- Are there hidden features that should be more visible? - -### 6. Composition & Balance -- Does the layout feel balanced or uncomfortably weighted? -- Is whitespace used intentionally or just leftover? -- Is there visual rhythm in spacing and repetition? -- Does asymmetry feel designed or accidental? - -### 7. Typography as Communication -- Does the type hierarchy clearly signal what to read first, second, third? -- Is body text comfortable to read? (line length, spacing, size) -- Do font choices reinforce the brand/tone? -- Is there enough contrast between heading levels? - -### 8. Color with Purpose -- Is color used to communicate, not just decorate? -- Does the palette feel cohesive? -- Are accent colors drawing attention to the right things? -- Does it work for colorblind users? (not just technically—does meaning still come through?) - -### 9. States & Edge Cases -- Empty states: Do they guide users toward action, or just say "nothing here"? -- Loading states: Do they reduce perceived wait time? -- Error states: Are they helpful and non-blaming? -- Success states: Do they confirm and guide next steps? - -### 10. Microcopy & Voice -- Is the writing clear and concise? -- Does it sound like a human (the right human for this brand)? -- Are labels and buttons unambiguous? -- Does error copy help users fix the problem? - -## Generate Critique Report - -Structure your feedback as a design director would: - -### Anti-Patterns Verdict -**Start here.** Pass/fail: Does this look AI-generated? List specific tells from the skill's Anti-Patterns section. Be brutally honest. - -### Overall Impression -A brief gut reaction—what works, what doesn't, and the single biggest opportunity. - -### What's Working -Highlight 2-3 things done well. Be specific about why they work. - -### Priority Issues -The 3-5 most impactful design problems, ordered by importance: - -For each issue: -- **What**: Name the problem clearly -- **Why it matters**: How this hurts users or undermines goals -- **Fix**: What to do about it (be concrete) -- **Command**: Which command to use (prefer: /animate, /quieter, /optimize, /adapt, /clarify, /distill, /delight, /onboard, /normalize, /audit, /harden, /polish, /extract, /bolder, /critique, /colorize — or other installed skills you're sure exist) - -### Minor Observations -Quick notes on smaller issues worth addressing. - -### Questions to Consider -Provocative questions that might unlock better solutions: -- "What if the primary action were more prominent?" -- "Does this need to feel this complex?" -- "What would a confident version of this look like?" - -**Remember**: -- Be direct—vague feedback wastes everyone's time -- Be specific—"the submit button" not "some elements" -- Say what's wrong AND why it matters to users -- Give concrete suggestions, not just "consider exploring..." -- Prioritize ruthlessly—if everything is important, nothing is -- Don't soften criticism—developers need honest feedback to ship great design \ No newline at end of file diff --git a/skills/delight/SKILL.md b/skills/delight/SKILL.md deleted file mode 100644 index 6106d4d71..000000000 --- a/skills/delight/SKILL.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -name: delight -description: Add moments of joy, personality, and unexpected touches that make interfaces memorable and enjoyable to use. Elevates functional to delightful. -user-invokable: true -args: - - name: target - description: The feature or area to add delight to (optional) - required: false ---- - -Identify opportunities to add moments of joy, personality, and unexpected polish that transform functional interfaces into delightful experiences. - -## MANDATORY PREPARATION - -### Context Gathering (Do This First) - -You cannot do a great job without having necessary context, such as target audience (critical), desired use-cases (critical), brand personality (playful vs professional vs quirky vs elegant), and what's appropriate for the domain. - -Attempt to gather these from the current thread or codebase. - -1. If you don't find *exact* information and have to infer from existing design and functionality, you MUST STOP and STOP and call the AskUserQuestionTool to clarify. whether you got it right. -2. Otherwise, if you can't fully infer or your level of confidence is medium or lower, you MUST STOP and call the AskUserQuestionTool to clarify. clarifying questions first to complete your context. - -Do NOT proceed until you have answers. Delight that's wrong for the context is worse than no delight at all. - -### Use frontend-design skill - -Use the frontend-design skill for design principles and anti-patterns. Do NOT proceed until it has executed and you know all DO's and DON'Ts. - ---- - -## Assess Delight Opportunities - -Identify where delight would enhance (not distract from) the experience: - -1. **Find natural delight moments**: - - **Success states**: Completed actions (save, send, publish) - - **Empty states**: First-time experiences, onboarding - - **Loading states**: Waiting periods that could be entertaining - - **Achievements**: Milestones, streaks, completions - - **Interactions**: Hover states, clicks, drags - - **Errors**: Softening frustrating moments - - **Easter eggs**: Hidden discoveries for curious users - -2. **Understand the context**: - - What's the brand personality? (Playful? Professional? Quirky? Elegant?) - - Who's the audience? (Tech-savvy? Creative? Corporate?) - - What's the emotional context? (Accomplishment? Exploration? Frustration?) - - What's appropriate? (Banking app ≠ gaming app) - -3. **Define delight strategy**: - - **Subtle sophistication**: Refined micro-interactions (luxury brands) - - **Playful personality**: Whimsical illustrations and copy (consumer apps) - - **Helpful surprises**: Anticipating needs before users ask (productivity tools) - - **Sensory richness**: Satisfying sounds, smooth animations (creative tools) - -If any of these are unclear from the codebase, STOP and call the AskUserQuestionTool to clarify. - -**CRITICAL**: Delight should enhance usability, never obscure it. If users notice the delight more than accomplishing their goal, you've gone too far. - -## Delight Principles - -Follow these guidelines: - -### Delight Amplifies, Never Blocks -- Delight moments should be quick (< 1 second) -- Never delay core functionality for delight -- Make delight skippable or subtle -- Respect user's time and task focus - -### Surprise and Discovery -- Hide delightful details for users to discover -- Reward exploration and curiosity -- Don't announce every delight moment -- Let users share discoveries with others - -### Appropriate to Context -- Match delight to emotional moment (celebrate success, empathize with errors) -- Respect the user's state (don't be playful during critical errors) -- Match brand personality and audience expectations -- Cultural sensitivity (what's delightful varies by culture) - -### Compound Over Time -- Delight should remain fresh with repeated use -- Vary responses (not same animation every time) -- Reveal deeper layers with continued use -- Build anticipation through patterns - -## Delight Techniques - -Add personality and joy through these methods: - -### Micro-interactions & Animation - -**Button delight**: -```css -/* Satisfying button press */ -.button { - transition: transform 0.1s, box-shadow 0.1s; -} -.button:active { - transform: translateY(2px); - box-shadow: 0 2px 4px rgba(0,0,0,0.2); -} - -/* Ripple effect on click */ -/* Smooth lift on hover */ -.button:hover { - transform: translateY(-2px); - transition: transform 0.2s cubic-bezier(0.25, 1, 0.5, 1); /* ease-out-quart */ -} -``` - -**Loading delight**: -- Playful loading animations (not just spinners) -- Personality in loading messages ("Herding pixels..." "Teaching robots to dance...") -- Progress indication with encouraging messages -- Skeleton screens with subtle animations - -**Success animations**: -- Checkmark draw animation -- Confetti burst for major achievements -- Gentle scale + fade for confirmation -- Satisfying sound effects (subtle) - -**Hover surprises**: -- Icons that animate on hover -- Color shifts or glow effects -- Tooltip reveals with personality -- Cursor changes (custom cursors for branded experiences) - -### Personality in Copy - -**Playful error messages**: -``` -"Error 404" -"This page is playing hide and seek. (And winning)" - -"Connection failed" -"Looks like the internet took a coffee break. Want to retry?" -``` - -**Encouraging empty states**: -``` -"No projects" -"Your canvas awaits. Create something amazing." - -"No messages" -"Inbox zero! You're crushing it today." -``` - -**Playful labels & tooltips**: -``` -"Delete" -"Send to void" (for playful brand) - -"Help" -"Rescue me" (tooltip) -``` - -**IMPORTANT**: Match copy personality to brand. Banks shouldn't be wacky, but they can be warm. - -### Illustrations & Visual Personality - -**Custom illustrations**: -- Empty state illustrations (not stock icons) -- Error state illustrations (friendly monsters, quirky characters) -- Loading state illustrations (animated characters) -- Success state illustrations (celebrations) - -**Icon personality**: -- Custom icon set matching brand personality -- Animated icons (subtle motion on hover/click) -- Illustrative icons (more detailed than generic) -- Consistent style across all icons - -**Background effects**: -- Subtle particle effects -- Gradient mesh backgrounds -- Geometric patterns -- Parallax depth -- Time-of-day themes (morning vs night) - -### Satisfying Interactions - -**Drag and drop delight**: -- Lift effect on drag (shadow, scale) -- Snap animation when dropped -- Satisfying placement sound -- Undo toast ("Dropped in wrong place? [Undo]") - -**Toggle switches**: -- Smooth slide with spring physics -- Color transition -- Haptic feedback on mobile -- Optional sound effect - -**Progress & achievements**: -- Streak counters with celebratory milestones -- Progress bars that "celebrate" at 100% -- Badge unlocks with animation -- Playful stats ("You're on fire! 5 days in a row") - -**Form interactions**: -- Input fields that animate on focus -- Checkboxes that bounce when checked -- Success state that celebrates valid input -- Auto-grow textareas - -### Sound Design - -**Subtle audio cues** (when appropriate): -- Notification sounds (distinctive but not annoying) -- Success sounds (satisfying "ding") -- Error sounds (empathetic, not harsh) -- Typing sounds for chat/messaging -- Ambient background audio (very subtle) - -**IMPORTANT**: -- Respect system sound settings -- Provide mute option -- Keep volumes quiet (subtle cues, not alarms) -- Don't play on every interaction (sound fatigue is real) - -### Easter Eggs & Hidden Delights - -**Discovery rewards**: -- Konami code unlocks special theme -- Hidden keyboard shortcuts (Cmd+K for special features) -- Hover reveals on logos or illustrations -- Alt text jokes on images (for screen reader users too!) -- Console messages for developers ("Like what you see? We're hiring!") - -**Seasonal touches**: -- Holiday themes (subtle, tasteful) -- Seasonal color shifts -- Weather-based variations -- Time-based changes (dark at night, light during day) - -**Contextual personality**: -- Different messages based on time of day -- Responses to specific user actions -- Randomized variations (not same every time) -- Progressive reveals with continued use - -### Loading & Waiting States - -**Make waiting engaging**: -- Interesting loading messages that rotate -- Progress bars with personality -- Mini-games during long loads -- Fun facts or tips while waiting -- Countdown with encouraging messages - -``` -Loading messages rotation: -- "Waking up the servers..." -- "Teaching robots to dance..." -- "Consulting the magic 8-ball..." -- "Counting backwards from infinity..." -``` - -### Celebration Moments - -**Success celebrations**: -- Confetti for major milestones -- Animated checkmarks for completions -- Progress bar celebrations at 100% -- "Achievement unlocked" style notifications -- Personalized messages ("You published your 10th article!") - -**Milestone recognition**: -- First-time actions get special treatment -- Streak tracking and celebration -- Progress toward goals -- Anniversary celebrations - -## Implementation Patterns - -**Animation libraries**: -- Framer Motion (React) -- GSAP (universal) -- Lottie (After Effects animations) -- Canvas confetti (party effects) - -**Sound libraries**: -- Howler.js (audio management) -- Use-sound (React hook) - -**Physics libraries**: -- React Spring (spring physics) -- Popmotion (animation primitives) - -**IMPORTANT**: File size matters. Compress images, optimize animations, lazy load delight features. - -**NEVER**: -- Delay core functionality for delight -- Force users through delightful moments (make skippable) -- Use delight to hide poor UX -- Overdo it (less is more) -- Ignore accessibility (animate responsibly, provide alternatives) -- Make every interaction delightful (special moments should be special) -- Sacrifice performance for delight -- Be inappropriate for context (read the room) - -## Verify Delight Quality - -Test that delight actually delights: - -- **User reactions**: Do users smile? Share screenshots? -- **Doesn't annoy**: Still pleasant after 100th time? -- **Doesn't block**: Can users opt out or skip? -- **Performant**: No jank, no slowdown -- **Appropriate**: Matches brand and context -- **Accessible**: Works with reduced motion, screen readers - -Remember: Delight is the difference between a tool and an experience. Add personality, surprise users positively, and create moments worth sharing. But always respect usability - delight should enhance, never obstruct. \ No newline at end of file diff --git a/skills/distill/SKILL.md b/skills/distill/SKILL.md deleted file mode 100644 index b9f0ddf28..000000000 --- a/skills/distill/SKILL.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -name: distill -description: Strip designs to their essence by removing unnecessary complexity. Great design is simple, powerful, and clean. -user-invokable: true -args: - - name: target - description: The feature or component to distill (optional) - required: false ---- - -Remove unnecessary complexity from designs, revealing the essential elements and creating clarity through ruthless simplification. - -## MANDATORY PREPARATION - -### Context Gathering (Do This First) - -You cannot do a great job without having necessary context, such as target audience (critical), desired use-cases (critical), and understanding what's truly essential vs nice-to-have for this product. - -Attempt to gather these from the current thread or codebase. - -1. If you don't find *exact* information and have to infer from existing design and functionality, you MUST STOP and STOP and call the AskUserQuestionTool to clarify. whether you got it right. -2. Otherwise, if you can't fully infer or your level of confidence is medium or lower, you MUST STOP and call the AskUserQuestionTool to clarify. clarifying questions first to complete your context. - -Do NOT proceed until you have answers. Simplifying the wrong things destroys usability. - -### Use frontend-design skill - -Use the frontend-design skill for design principles and anti-patterns. Do NOT proceed until it has executed and you know all DO's and DON'Ts. - ---- - -## Assess Current State - -Analyze what makes the design feel complex or cluttered: - -1. **Identify complexity sources**: - - **Too many elements**: Competing buttons, redundant information, visual clutter - - **Excessive variation**: Too many colors, fonts, sizes, styles without purpose - - **Information overload**: Everything visible at once, no progressive disclosure - - **Visual noise**: Unnecessary borders, shadows, backgrounds, decorations - - **Confusing hierarchy**: Unclear what matters most - - **Feature creep**: Too many options, actions, or paths forward - -2. **Find the essence**: - - What's the primary user goal? (There should be ONE) - - What's actually necessary vs nice-to-have? - - What can be removed, hidden, or combined? - - What's the 20% that delivers 80% of value? - -If any of these are unclear from the codebase, STOP and call the AskUserQuestionTool to clarify. - -**CRITICAL**: Simplicity is not about removing features - it's about removing obstacles between users and their goals. Every element should justify its existence. - -## Plan Simplification - -Create a ruthless editing strategy: - -- **Core purpose**: What's the ONE thing this should accomplish? -- **Essential elements**: What's truly necessary to achieve that purpose? -- **Progressive disclosure**: What can be hidden until needed? -- **Consolidation opportunities**: What can be combined or integrated? - -**IMPORTANT**: Simplification is hard. It requires saying no to good ideas to make room for great execution. Be ruthless. - -## Simplify the Design - -Systematically remove complexity across these dimensions: - -### Information Architecture -- **Reduce scope**: Remove secondary actions, optional features, redundant information -- **Progressive disclosure**: Hide complexity behind clear entry points (accordions, modals, step-through flows) -- **Combine related actions**: Merge similar buttons, consolidate forms, group related content -- **Clear hierarchy**: ONE primary action, few secondary actions, everything else tertiary or hidden -- **Remove redundancy**: If it's said elsewhere, don't repeat it here - -### Visual Simplification -- **Reduce color palette**: Use 1-2 colors plus neutrals, not 5-7 colors -- **Limit typography**: One font family, 3-4 sizes maximum, 2-3 weights -- **Remove decorations**: Eliminate borders, shadows, backgrounds that don't serve hierarchy or function -- **Flatten structure**: Reduce nesting, remove unnecessary containers—never nest cards inside cards -- **Remove unnecessary cards**: Cards aren't needed for basic layout; use spacing and alignment instead -- **Consistent spacing**: Use one spacing scale, remove arbitrary gaps - -### Layout Simplification -- **Linear flow**: Replace complex grids with simple vertical flow where possible -- **Remove sidebars**: Move secondary content inline or hide it -- **Full-width**: Use available space generously instead of complex multi-column layouts -- **Consistent alignment**: Pick left or center, stick with it -- **Generous white space**: Let content breathe, don't pack everything tight - -### Interaction Simplification -- **Reduce choices**: Fewer buttons, fewer options, clearer path forward (paradox of choice is real) -- **Smart defaults**: Make common choices automatic, only ask when necessary -- **Inline actions**: Replace modal flows with inline editing where possible -- **Remove steps**: Can signup be one step instead of three? Can checkout be simplified? -- **Clear CTAs**: ONE obvious next step, not five competing actions - -### Content Simplification -- **Shorter copy**: Cut every sentence in half, then do it again -- **Active voice**: "Save changes" not "Changes will be saved" -- **Remove jargon**: Plain language always wins -- **Scannable structure**: Short paragraphs, bullet points, clear headings -- **Essential information only**: Remove marketing fluff, legalese, hedging -- **Remove redundant copy**: No headers restating intros, no repeated explanations, say it once - -### Code Simplification -- **Remove unused code**: Dead CSS, unused components, orphaned files -- **Flatten component trees**: Reduce nesting depth -- **Consolidate styles**: Merge similar styles, use utilities consistently -- **Reduce variants**: Does that component need 12 variations, or can 3 cover 90% of cases? - -**NEVER**: -- Remove necessary functionality (simplicity ≠ feature-less) -- Sacrifice accessibility for simplicity (clear labels and ARIA still required) -- Make things so simple they're unclear (mystery ≠ minimalism) -- Remove information users need to make decisions -- Eliminate hierarchy completely (some things should stand out) -- Oversimplify complex domains (match complexity to actual task complexity) - -## Verify Simplification - -Ensure simplification improves usability: - -- **Faster task completion**: Can users accomplish goals more quickly? -- **Reduced cognitive load**: Is it easier to understand what to do? -- **Still complete**: Are all necessary features still accessible? -- **Clearer hierarchy**: Is it obvious what matters most? -- **Better performance**: Does simpler design load faster? - -## Document Removed Complexity - -If you removed features or options: -- Document why they were removed -- Consider if they need alternative access points -- Note any user feedback to monitor - -Remember: You have great taste and judgment. Simplification is an act of confidence - knowing what to keep and courage to remove the rest. As Antoine de Saint-Exupéry said: "Perfection is achieved not when there is nothing more to add, but when there is nothing left to take away." \ No newline at end of file diff --git a/skills/extract/SKILL.md b/skills/extract/SKILL.md deleted file mode 100644 index 207621a10..000000000 --- a/skills/extract/SKILL.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -name: extract -description: Extract and consolidate reusable components, design tokens, and patterns into your design system. Identifies opportunities for systematic reuse and enriches your component library. -user-invokable: true -args: - - name: target - description: The feature, component, or area to extract from (optional) - required: false ---- - -Identify reusable patterns, components, and design tokens, then extract and consolidate them into the design system for systematic reuse. - -## Discover - -Analyze the target area to identify extraction opportunities: - -1. **Find the design system**: Locate your design system, component library, or shared UI directory (grep for "design system", "ui", "components", etc.). Understand its structure: - - Component organization and naming conventions - - Design token structure (if any) - - Documentation patterns - - Import/export conventions - - **CRITICAL**: If no design system exists, ask before creating one. Understand the preferred location and structure first. - -2. **Identify patterns**: Look for: - - **Repeated components**: Similar UI patterns used multiple times (buttons, cards, inputs, etc.) - - **Hard-coded values**: Colors, spacing, typography, shadows that should be tokens - - **Inconsistent variations**: Multiple implementations of the same concept (3 different button styles) - - **Reusable patterns**: Layout patterns, composition patterns, interaction patterns worth systematizing - -3. **Assess value**: Not everything should be extracted. Consider: - - Is this used 3+ times, or likely to be reused? - - Would systematizing this improve consistency? - - Is this a general pattern or context-specific? - - What's the maintenance cost vs benefit? - -## Plan Extraction - -Create a systematic extraction plan: - -- **Components to extract**: Which UI elements become reusable components? -- **Tokens to create**: Which hard-coded values become design tokens? -- **Variants to support**: What variations does each component need? -- **Naming conventions**: Component names, token names, prop names that match existing patterns -- **Migration path**: How to refactor existing uses to consume the new shared versions - -**IMPORTANT**: Design systems grow incrementally. Extract what's clearly reusable now, not everything that might someday be reusable. - -## Extract & Enrich - -Build improved, reusable versions: - -- **Components**: Create well-designed components with: - - Clear props API with sensible defaults - - Proper variants for different use cases - - Accessibility built in (ARIA, keyboard navigation, focus management) - - Documentation and usage examples - -- **Design tokens**: Create tokens with: - - Clear naming (primitive vs semantic) - - Proper hierarchy and organization - - Documentation of when to use each token - -- **Patterns**: Document patterns with: - - When to use this pattern - - Code examples - - Variations and combinations - -**NEVER**: -- Extract one-off, context-specific implementations without generalization -- Create components so generic they're useless -- Extract without considering existing design system conventions -- Skip proper TypeScript types or prop documentation -- Create tokens for every single value (tokens should have semantic meaning) - -## Migrate - -Replace existing uses with the new shared versions: - -- **Find all instances**: Search for the patterns you've extracted -- **Replace systematically**: Update each use to consume the shared version -- **Test thoroughly**: Ensure visual and functional parity -- **Delete dead code**: Remove the old implementations - -## Document - -Update design system documentation: - -- Add new components to the component library -- Document token usage and values -- Add examples and guidelines -- Update any Storybook or component catalog - -Remember: A good design system is a living system. Extract patterns as they emerge, enrich them thoughtfully, and maintain them consistently. \ No newline at end of file diff --git a/skills/frontend-design/SKILL.md b/skills/frontend-design/SKILL.md deleted file mode 100644 index c78cca7e0..000000000 --- a/skills/frontend-design/SKILL.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -name: frontend-design -description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications. Generates creative, polished code that avoids generic AI aesthetics. -license: Apache 2.0. Based on Anthropic's frontend-design skill. See NOTICE.md for attribution. ---- - -This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices. - -## Design Direction - -Commit to a BOLD aesthetic direction: -- **Purpose**: What problem does this interface solve? Who uses it? -- **Tone**: Pick an extreme: brutally minimal, maximalist chaos, retro-futuristic, organic/natural, luxury/refined, playful/toy-like, editorial/magazine, brutalist/raw, art deco/geometric, soft/pastel, industrial/utilitarian, etc. There are so many flavors to choose from. Use these for inspiration but design one that is true to the aesthetic direction. -- **Constraints**: Technical requirements (framework, performance, accessibility). -- **Differentiation**: What makes this UNFORGETTABLE? What's the one thing someone will remember? - -**CRITICAL**: Choose a clear conceptual direction and execute it with precision. Bold maximalism and refined minimalism both work—the key is intentionality, not intensity. - -Then implement working code that is: -- Production-grade and functional -- Visually striking and memorable -- Cohesive with a clear aesthetic point-of-view -- Meticulously refined in every detail - -## Frontend Aesthetics Guidelines - -### Typography -→ *Consult [typography reference](reference/typography.md) for scales, pairing, and loading strategies.* - -Choose fonts that are beautiful, unique, and interesting. Pair a distinctive display font with a refined body font. - -**DO**: Use a modular type scale with fluid sizing (clamp) -**DO**: Vary font weights and sizes to create clear visual hierarchy -**DON'T**: Use overused fonts—Inter, Roboto, Arial, Open Sans, system defaults -**DON'T**: Use monospace typography as lazy shorthand for "technical/developer" vibes -**DON'T**: Put large icons with rounded corners above every heading—they rarely add value and make sites look templated - -### Color & Theme -→ *Consult [color reference](reference/color-and-contrast.md) for OKLCH, palettes, and dark mode.* - -Commit to a cohesive palette. Dominant colors with sharp accents outperform timid, evenly-distributed palettes. - -**DO**: Use modern CSS color functions (oklch, color-mix, light-dark) for perceptually uniform, maintainable palettes -**DO**: Tint your neutrals toward your brand hue—even a subtle hint creates subconscious cohesion -**DON'T**: Use gray text on colored backgrounds—it looks washed out; use a shade of the background color instead -**DON'T**: Use pure black (#000) or pure white (#fff)—always tint; pure black/white never appears in nature -**DON'T**: Use the AI color palette: cyan-on-dark, purple-to-blue gradients, neon accents on dark backgrounds -**DON'T**: Use gradient text for "impact"—especially on metrics or headings; it's decorative rather than meaningful -**DON'T**: Default to dark mode with glowing accents—it looks "cool" without requiring actual design decisions - -### Layout & Space -→ *Consult [spatial reference](reference/spatial-design.md) for grids, rhythm, and container queries.* - -Create visual rhythm through varied spacing—not the same padding everywhere. Embrace asymmetry and unexpected compositions. Break the grid intentionally for emphasis. - -**DO**: Create visual rhythm through varied spacing—tight groupings, generous separations -**DO**: Use fluid spacing with clamp() that breathes on larger screens -**DO**: Use asymmetry and unexpected compositions; break the grid intentionally for emphasis -**DON'T**: Wrap everything in cards—not everything needs a container -**DON'T**: Nest cards inside cards—visual noise, flatten the hierarchy -**DON'T**: Use identical card grids—same-sized cards with icon + heading + text, repeated endlessly -**DON'T**: Use the hero metric layout template—big number, small label, supporting stats, gradient accent -**DON'T**: Center everything—left-aligned text with asymmetric layouts feels more designed -**DON'T**: Use the same spacing everywhere—without rhythm, layouts feel monotonous - -### Visual Details -**DO**: Use intentional, purposeful decorative elements that reinforce brand -**DON'T**: Use glassmorphism everywhere—blur effects, glass cards, glow borders used decoratively rather than purposefully -**DON'T**: Use rounded elements with thick colored border on one side—a lazy accent that almost never looks intentional -**DON'T**: Use sparklines as decoration—tiny charts that look sophisticated but convey nothing meaningful -**DON'T**: Use rounded rectangles with generic drop shadows—safe, forgettable, could be any AI output -**DON'T**: Use modals unless there's truly no better alternative—modals are lazy - -### Motion -→ *Consult [motion reference](reference/motion-design.md) for timing, easing, and reduced motion.* - -Focus on high-impact moments: one well-orchestrated page load with staggered reveals creates more delight than scattered micro-interactions. - -**DO**: Use motion to convey state changes—entrances, exits, feedback -**DO**: Use exponential easing (ease-out-quart/quint/expo) for natural deceleration -**DO**: For height animations, use grid-template-rows transitions instead of animating height directly -**DON'T**: Animate layout properties (width, height, padding, margin)—use transform and opacity only -**DON'T**: Use bounce or elastic easing—they feel dated and tacky; real objects decelerate smoothly - -### Interaction -→ *Consult [interaction reference](reference/interaction-design.md) for forms, focus, and loading patterns.* - -Make interactions feel fast. Use optimistic UI—update immediately, sync later. - -**DO**: Use progressive disclosure—start simple, reveal sophistication through interaction (basic options first, advanced behind expandable sections; hover states that reveal secondary actions) -**DO**: Design empty states that teach the interface, not just say "nothing here" -**DO**: Make every interactive surface feel intentional and responsive -**DON'T**: Repeat the same information—redundant headers, intros that restate the heading -**DON'T**: Make every button primary—use ghost buttons, text links, secondary styles; hierarchy matters - -### Responsive -→ *Consult [responsive reference](reference/responsive-design.md) for mobile-first, fluid design, and container queries.* - -**DO**: Use container queries (@container) for component-level responsiveness -**DO**: Adapt the interface for different contexts—don't just shrink it -**DON'T**: Hide critical functionality on mobile—adapt the interface, don't amputate it - -### UX Writing -→ *Consult [ux-writing reference](reference/ux-writing.md) for labels, errors, and empty states.* - -**DO**: Make every word earn its place -**DON'T**: Repeat information users can already see - ---- - -## The AI Slop Test - -**Critical quality check**: If you showed this interface to someone and said "AI made this," would they believe you immediately? If yes, that's the problem. - -A distinctive interface should make someone ask "how was this made?" not "which AI made this?" - -Review the DON'T guidelines above—they are the fingerprints of AI-generated work from 2024-2025. - ---- - -## Implementation Principles - -Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate code with extensive animations and effects. Minimalist or refined designs need restraint, precision, and careful attention to spacing, typography, and subtle details. - -Interpret creatively and make unexpected choices that feel genuinely designed for the context. No design should be the same. Vary between light and dark themes, different fonts, different aesthetics. NEVER converge on common choices across generations. - -Remember: Claude is capable of extraordinary creative work. Don't hold back—show what can truly be created when thinking outside the box and committing fully to a distinctive vision. \ No newline at end of file diff --git a/skills/frontend-design/reference/color-and-contrast.md b/skills/frontend-design/reference/color-and-contrast.md deleted file mode 100644 index 77aaf0329..000000000 --- a/skills/frontend-design/reference/color-and-contrast.md +++ /dev/null @@ -1,132 +0,0 @@ -# Color & Contrast - -## Color Spaces: Use OKLCH - -**Stop using HSL.** Use OKLCH (or LCH) instead. It's perceptually uniform, meaning equal steps in lightness *look* equal—unlike HSL where 50% lightness in yellow looks bright while 50% in blue looks dark. - -```css -/* OKLCH: lightness (0-100%), chroma (0-0.4+), hue (0-360) */ ---color-primary: oklch(60% 0.15 250); /* Blue */ ---color-primary-light: oklch(85% 0.08 250); /* Same hue, lighter */ ---color-primary-dark: oklch(35% 0.12 250); /* Same hue, darker */ -``` - -**Key insight**: As you move toward white or black, reduce chroma (saturation). High chroma at extreme lightness looks garish. A light blue at 85% lightness needs ~0.08 chroma, not the 0.15 of your base color. - -## Building Functional Palettes - -### The Tinted Neutral Trap - -**Pure gray is dead.** Add a subtle hint of your brand hue to all neutrals: - -```css -/* Dead grays */ ---gray-100: oklch(95% 0 0); /* No personality */ ---gray-900: oklch(15% 0 0); - -/* Warm-tinted grays (add brand warmth) */ ---gray-100: oklch(95% 0.01 60); /* Hint of warmth */ ---gray-900: oklch(15% 0.01 60); - -/* Cool-tinted grays (tech, professional) */ ---gray-100: oklch(95% 0.01 250); /* Hint of blue */ ---gray-900: oklch(15% 0.01 250); -``` - -The chroma is tiny (0.01) but perceptible. It creates subconscious cohesion between your brand color and your UI. - -### Palette Structure - -A complete system needs: - -| Role | Purpose | Example | -|------|---------|---------| -| **Primary** | Brand, CTAs, key actions | 1 color, 3-5 shades | -| **Neutral** | Text, backgrounds, borders | 9-11 shade scale | -| **Semantic** | Success, error, warning, info | 4 colors, 2-3 shades each | -| **Surface** | Cards, modals, overlays | 2-3 elevation levels | - -**Skip secondary/tertiary unless you need them.** Most apps work fine with one accent color. Adding more creates decision fatigue and visual noise. - -### The 60-30-10 Rule (Applied Correctly) - -This rule is about **visual weight**, not pixel count: - -- **60%**: Neutral backgrounds, white space, base surfaces -- **30%**: Secondary colors—text, borders, inactive states -- **10%**: Accent—CTAs, highlights, focus states - -The common mistake: using the accent color everywhere because it's "the brand color." Accent colors work *because* they're rare. Overuse kills their power. - -## Contrast & Accessibility - -### WCAG Requirements - -| Content Type | AA Minimum | AAA Target | -|--------------|------------|------------| -| Body text | 4.5:1 | 7:1 | -| Large text (18px+ or 14px bold) | 3:1 | 4.5:1 | -| UI components, icons | 3:1 | 4.5:1 | -| Non-essential decorations | None | None | - -**The gotcha**: Placeholder text still needs 4.5:1. That light gray placeholder you see everywhere? Usually fails WCAG. - -### Dangerous Color Combinations - -These commonly fail contrast or cause readability issues: - -- Light gray text on white (the #1 accessibility fail) -- **Gray text on any colored background**—gray looks washed out and dead on color. Use a darker shade of the background color, or transparency -- Red text on green background (or vice versa)—8% of men can't distinguish these -- Blue text on red background (vibrates visually) -- Yellow text on white (almost always fails) -- Thin light text on images (unpredictable contrast) - -### Never Use Pure Gray or Pure Black - -Pure gray (`oklch(50% 0 0)`) and pure black (`#000`) don't exist in nature—real shadows and surfaces always have a color cast. Even a chroma of 0.005-0.01 is enough to feel natural without being obviously tinted. (See tinted neutrals example above.) - -### Testing - -Don't trust your eyes. Use tools: - -- [WebAIM Contrast Checker](https://webaim.org/resources/contrastchecker/) -- Browser DevTools → Rendering → Emulate vision deficiencies -- [Polypane](https://polypane.app/) for real-time testing - -## Theming: Light & Dark Mode - -### Dark Mode Is Not Inverted Light Mode - -You can't just swap colors. Dark mode requires different design decisions: - -| Light Mode | Dark Mode | -|------------|-----------| -| Shadows for depth | Lighter surfaces for depth (no shadows) | -| Dark text on light | Light text on dark (reduce font weight) | -| Vibrant accents | Desaturate accents slightly | -| White backgrounds | Never pure black—use dark gray (oklch 12-18%) | - -```css -/* Dark mode depth via surface color, not shadow */ -:root[data-theme="dark"] { - --surface-1: oklch(15% 0.01 250); - --surface-2: oklch(20% 0.01 250); /* "Higher" = lighter */ - --surface-3: oklch(25% 0.01 250); - - /* Reduce text weight slightly */ - --body-weight: 350; /* Instead of 400 */ -} -``` - -### Token Hierarchy - -Use two layers: primitive tokens (`--blue-500`) and semantic tokens (`--color-primary: var(--blue-500)`). For dark mode, only redefine the semantic layer—primitives stay the same. - -## Alpha Is A Design Smell - -Heavy use of transparency (rgba, hsla) usually means an incomplete palette. Alpha creates unpredictable contrast, performance overhead, and inconsistency. Define explicit overlay colors for each context instead. Exception: focus rings and interactive states where see-through is needed. - ---- - -**Avoid**: Relying on color alone to convey information. Creating palettes without clear roles for each color. Using pure black (#000) for large areas. Skipping color blindness testing (8% of men affected). diff --git a/skills/frontend-design/reference/interaction-design.md b/skills/frontend-design/reference/interaction-design.md deleted file mode 100644 index 10a77564b..000000000 --- a/skills/frontend-design/reference/interaction-design.md +++ /dev/null @@ -1,123 +0,0 @@ -# Interaction Design - -## The Eight Interactive States - -Every interactive element needs these states designed: - -| State | When | Visual Treatment | -|-------|------|------------------| -| **Default** | At rest | Base styling | -| **Hover** | Pointer over (not touch) | Subtle lift, color shift | -| **Focus** | Keyboard/programmatic focus | Visible ring (see below) | -| **Active** | Being pressed | Pressed in, darker | -| **Disabled** | Not interactive | Reduced opacity, no pointer | -| **Loading** | Processing | Spinner, skeleton | -| **Error** | Invalid state | Red border, icon, message | -| **Success** | Completed | Green check, confirmation | - -**The common miss**: Designing hover without focus, or vice versa. They're different. Keyboard users never see hover states. - -## Focus Rings: Do Them Right - -**Never `outline: none` without replacement.** It's an accessibility violation. Instead, use `:focus-visible` to show focus only for keyboard users: - -```css -/* Hide focus ring for mouse/touch */ -button:focus { - outline: none; -} - -/* Show focus ring for keyboard */ -button:focus-visible { - outline: 2px solid var(--color-accent); - outline-offset: 2px; -} -``` - -**Focus ring design**: -- High contrast (3:1 minimum against adjacent colors) -- 2-3px thick -- Offset from element (not inside it) -- Consistent across all interactive elements - -## Form Design: The Non-Obvious - -**Placeholders aren't labels**—they disappear on input. Always use visible `