Commit graph

3 commits

Author SHA1 Message Date
Claude
c0546dbf46
style: Apply prettier formatting
Apply consistent code formatting with prettier to all project files
2025-11-15 16:14:34 +00:00
Claude
76949aaf48
docs: Convert all diagrams to Mermaid.js with GitHub dark mode colors
Updated all text-based diagrams to use Mermaid.js syntax with colors
optimized for GitHub dark mode viewing.

Changes:
- QUICK_REFERENCE.md: 2 diagrams converted
  • Data Flow (graph LR with color-coded stages)
  • Touch Event Flow (flowchart TD with detailed state tracking)

- ARCHITECTURE.md: 6 diagrams converted
  • High-Level Architecture (graph TB with subgraphs)
  • Complete User Interaction Flow (sequenceDiagram)
  • Signal Reactivity Flow (flowchart TD)
  • Gesture Detection State Machine (stateDiagram-v2)
  • Component Lifecycle (flowchart TD with feedback loops)
  • Event Listener Lifecycle (flowchart TD)

- docs/README.md: 3 diagrams converted
  • The Big Picture (flowchart TD)
  • Component Hierarchy (graph TD)
  • Data Flow (flowchart TD)

Color Palette (GitHub dark mode optimized):
- Blue (#58a6ff): Logic, calculations, core functions
- Green (#3fb950): Success states, event handlers, initialization
- Yellow/Orange (#d29922): Computed signals, state updates
- Purple (#a371f7): User actions, signals, reactivity
- Pink (#db61a2): Events, callbacks, emissions
- Red (#f85149): DOM updates, destruction, browser events

Benefits:
 Interactive diagrams render on GitHub
 Consistent color coding across all documentation
 Better readability in dark mode
 Professional visual presentation
 Easier to understand complex flows
2025-11-15 15:41:12 +00:00
Claude
0d933efbf1
docs: Add comprehensive maintainer documentation
Added complete documentation suite for library maintainers:

Documentation Files:
- docs/README.md - Documentation index and learning paths
- docs/QUICK_REFERENCE.md - Fast lookup guide with code locations
- docs/ARCHITECTURE.md - Deep technical dive into system design
- docs/IMPLEMENTATION_GUIDE.md - Step-by-step examples for features/fixes

Enhanced Code Readability:
- ivypinch.improved.ts - Heavily commented reference version
  - 800+ lines of inline documentation
  - Section-organized code structure
  - Mathematical formulas explained
  - Every state variable documented
  - Method purposes and algorithms detailed

Documentation Coverage:
 Component architecture and data flow
 Signal-based reactivity patterns
 Transform mathematics with formulas
 Touch gesture detection algorithms
 Event system and state machines
 Constraint system (zoom/pan limits)
 Performance optimization techniques
 Common bug fixes with solutions
 Feature implementation examples
 Debugging techniques and tools
 Testing strategies

This documentation enables new maintainers to:
- Understand how the library works internally
- Add new features following established patterns
- Fix bugs efficiently with debugging guides
- Optimize performance with best practices
- Navigate the codebase quickly

For maintainers: Start with docs/README.md for learning paths
2025-11-15 15:22:38 +00:00