How skaplanofficial/raycast-pins works
Main Components
a) Frontend Layer:
• React Components (from /src/components)
• Menu item components hierarchy
• Quick pins subsystem
b) Core Logic Layer:
• Library Components (from /src/lib)
• Groups Management
• Pins Management
• Local Data Handling
• Placeholders System
• Storage System
c) Integration Layer:
• Raycast API Integration
• File System Integration
• Menu Bar Integration
Component Relationships
• User Interface → Core Logic (show data flow)
• Core Logic → Storage (show persistence)
• Placeholders → Pins (show dynamic content injection)
• Menu Bar Extra ↔ Pin/Group Management
Specific Implementation Details
Create sections showing:
• The placeholder system architecture (extensive based on /src/lib/placeholders)
• Quick pins subsystem (from /components/menu-items/quick-pins)
• Data flow for pin/group management
Key Architectural Patterns to Highlight
• Component-based UI architecture
• Plugin system for placeholders
• Data persistence layer
• Event-driven menu bar integration
┌─────────────────────────────────────────┐
• User Interface │
• (Forms, Lists, Menus, Quick Actions) │
• ┤
• Core Logic │
• (Pins, Groups, Placeholders, Utils) │
• ┤
• Integration Layer │
• (Raycast API, FileSystem, MenuBar) │
• ┤
• Data Layer │
• (LocalStorage, Import/Export) │
• ┘
Important Elements to Include:
Placeholder system's extensibility
• How custom placeholders can be added
• Placeholder resolution flow
Quick pins feature
• Different types (App, Directory, Document, etc.)
• Their interaction with the core system
Data flow for key operations
• Pin creation/editing
• Management
• Menu bar updates
External Integration Points
• Raycast Extension API
• File System Access
• Menu Bar Integration
• Browser Integration (for tab pinning)