@liquidcommerce/elements-sdk 2.3.0 → 2.4.0

package/docs/DOCUMENTATION_INDEX.md

@@ -0,0 +1,311 @@
+# Documentation Index
+
+Complete guide to the LiquidCommerce Elements SDK documentation.
+
+## 📚 Core Documentation
+
+### [README.md](../README.md)
+**Main entry point** for the SDK with progressive learning path.
+
+**Contents:**
+- Quick Start guide (auto-initialization)
+- Advanced usage (programmatic init)
+- Configuration reference
+- SDK methods & API
+- UI helpers
+- Programmatic control (actions)
+- Events system
+- Themes & customization
+- Features deep dive
+- Core capabilities
+- Integration patterns
+- Error handling
+- Performance & best practices
+- Proxy configuration
+- FAQ
+- Versioning
+- Demo pages
+- Browser support
+
+**Best for:** Getting started, overview of all features
+
+---
+
+## 🔧 Technical References
+
+### [CONFIGURATION.md](./CONFIGURATION.md)
+**Complete configuration reference** for all SDK options.
+
+**Contents:**
+- Basic configuration
+- All configuration options with types
+- Auto-initialization attributes
+- URL parameter configuration
+- TypeScript types
+- Configuration examples
+- Environment variables
+- Best practices
+
+**Best for:** Understanding all config options, TypeScript developers
+
+### [THEMING.md](./THEMING.md)
+**Complete theming guide** for customizing component appearance.
+
+**Contents:**
+- Global theme configuration
+- Colors, typography, spacing
+- Border radius, shadows, transitions
+- Product component theme
+- Cart component theme
+- Checkout component theme
+- Address component theme
+- Dynamic theme updates (builder mode)
+- Theme presets (example configurations)
+- Best practices
+
+**Best for:** Designers, frontend developers customizing appearance
+
+### [ACTIONS.md](./ACTIONS.md)
+**Programmatic control reference** for all available actions.
+
+**Contents:**
+- Product actions
+- Address actions (Google Places & manual)
+- Cart actions (including programmatic addProduct)
+- Checkout actions (including programmatic addProduct)
+- Action feedback events
+- Event handling best practices
+- Real-world business scenarios
+- Implementation strategy
+- Common integration patterns
+- Business ROI tracking
+
+**Best for:** Developers building custom flows, automation
+
+### [EVENTS.md](./EVENTS.md)
+**Event system reference** for tracking and responding to user interactions.
+
+**Contents:**
+- SDK lifecycle events
+- Product events
+- Cart events
+- Checkout events
+- Address events
+- Action feedback events
+- Security notes
+- Implementation examples
+- Real-world use cases
+- Cart abandonment recovery
+- Revenue optimization
+- Conversion tracking
+
+**Best for:** Analytics integration, custom behaviors, tracking
+
+### [PROXY.md](./PROXY.md)
+**Proxy configuration guide** for routing API requests through your server.
+
+**Contents:**
+- Quick setup
+- How it works
+- Required headers
+- Next.js implementation (Pages Router & App Router)
+- Testing
+- Security considerations
+- Benefits
+- Configuration options
+
+**Best for:** Avoiding ad blockers, custom routing, monitoring
+
+### [BROWSER_SUPPORT.md](./BROWSER_SUPPORT.md)
+**Browser compatibility reference** with detailed support information.
+
+**Contents:**
+- Minimum supported versions
+- Polyfills included
+- Transpilation targets
+- Testing recommendations
+- Mobile support
+- PWA support
+- Known limitations
+- Browser-specific notes
+- Feature detection
+- Detailed version support by year
+
+**Best for:** QA teams, compatibility planning
+
+### [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
+**Comprehensive troubleshooting guide** for common issues and solutions.
+
+**Contents:**
+- SDK initialization issues
+- Component rendering issues
+- Event handling issues
+- Cart & checkout issues
+- Address validation issues
+- Network & API issues
+- Performance issues
+- Mobile-specific issues
+- Framework-specific issues (React, Next.js, Vue)
+- Browser-specific issues
+- Debugging tools
+- Getting help
+
+**Best for:** Debugging, problem-solving, support
+
+---
+
+## 📖 Documentation Structure
+
+```
+docs/
+├── DOCUMENTATION_INDEX.md    ← You are here
+├── CONFIGURATION.md           ← Config reference
+├── THEMING.md                 ← Theming guide
+├── ACTIONS.md                 ← Actions reference
+├── EVENTS.md                  ← Events reference
+├── PROXY.md                   ← Proxy setup
+├── BROWSER_SUPPORT.md         ← Browser compatibility
+└── TROUBLESHOOTING.md         ← Problem solving
+```
+
+---
+
+## 🎯 Documentation by Use Case
+
+### I want to...
+
+#### Get started quickly
+→ [README.md - Quick Start](../README.md#-quick-start)
+
+#### Customize the appearance
+→ [THEMING.md](./THEMING.md)
+
+#### Build custom flows
+→ [ACTIONS.md](./ACTIONS.md)
+
+#### Track user behavior
+→ [EVENTS.md](./EVENTS.md)
+
+#### Configure the SDK
+→ [CONFIGURATION.md](./CONFIGURATION.md)
+
+#### Avoid ad blockers
+→ [PROXY.md](./PROXY.md)
+
+#### Check browser support
+→ [BROWSER_SUPPORT.md](./BROWSER_SUPPORT.md)
+
+#### Fix an issue
+→ [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
+
+#### Integrate with React/Vue/Next.js
+→ [README.md - Integration Patterns](../README.md#-integration-patterns)
+
+#### Understand error handling
+→ [README.md - Error Handling](../README.md#-error-handling)
+
+#### Optimize performance
+→ [README.md - Performance & Best Practices](../README.md#-performance--best-practices)
+
+---
+
+## 🚀 Quick Links
+
+### Getting Started
+- [30-Second Setup](../README.md#the-simplest-setup-30-seconds)
+- [Adding Products](../README.md#adding-products-to-your-page)
+- [Auto-Init Reference](../README.md#complete-auto-init-reference)
+
+### Configuration
+- [Environment Options](./CONFIGURATION.md#env-required)
+- [Debug Modes](./CONFIGURATION.md#debugmode)
+- [Proxy Setup](./PROXY.md)
+- [Theme Configuration](./THEMING.md)
+
+### Development
+- [Programmatic Init](../README.md#programmatic-initialization)
+- [Actions API](../README.md#programmatic-control-actions)
+- [Events System](../README.md#-events)
+- [Builder Mode](./CONFIGURATION.md#isbuilder)
+
+### Integration
+- [React Integration](../README.md#react-integration)
+- [Next.js Integration](../README.md#nextjs-integration)
+- [Vue Integration](../README.md#vue-integration)
+- [WordPress Integration](../README.md#wordpress-integration)
+- [Shopify Integration](../README.md#shopify-integration)
+
+### Features
+- [Product Engraving](../README.md#product-engraving)
+- [Gift Options](../README.md#gift-options)
+- [Promo Codes](../README.md#promo-codes)
+- [Gift Cards](../README.md#gift-cards)
+- [Tips](../README.md#tips-on-demand-delivery)
+- [Marketing Preferences](../README.md#marketing-preferences)
+
+### Advanced
+- [Core Capabilities](../README.md#-core-capabilities)
+- [State Management](../README.md#state-management)
+- [Event System (PubSub)](../README.md#event-system-pubsub)
+- [Telemetry & Analytics](../README.md#telemetry--analytics)
+- [Circuit Breaker](../README.md#circuit-breaker)
+- [Command Pattern](../README.md#command-pattern)
+
+### Troubleshooting
+- [SDK Not Loading](./TROUBLESHOOTING.md#sdk-not-loading)
+- [Components Not Appearing](./TROUBLESHOOTING.md#components-not-appearing)
+- [Events Not Firing](./TROUBLESHOOTING.md#events-not-firing)
+- [Cart Not Persisting](./TROUBLESHOOTING.md#cart-not-persisting)
+- [CORS Errors](./TROUBLESHOOTING.md#cors-errors)
+
+### Adding Examples
+Want to contribute an example?
+- Must be tested and working
+- Follow style guidelines
+- Include use case description
+- Keep it minimal and focused
+
+---
+
+## 📞 Need Help?
+
+1. **Check the docs** - Start with this index
+2. **Search for your issue** - Use browser search (Cmd/Ctrl + F)
+3. **Try troubleshooting** - [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
+4. **Enable debug mode** - See errors in console/panel
+5. **Check status page** - LiquidCommerce API status
+6. **Contact support** - With SDK version, browser, and error details
+
+---
+
+## 🎓 Learning Path
+
+### Beginner
+1. [README - Quick Start](../README.md#-quick-start)
+2. [README - Adding Products](../README.md#adding-products-to-your-page)
+3. [README - Configuration](../README.md#-configuration)
+4. [EVENTS.md - Quick Implementation](./EVENTS.md#quick-implementation-guide)
+
+### Intermediate
+1. [README - Advanced Usage](../README.md#-advanced-usage)
+2. [ACTIONS.md](./ACTIONS.md)
+3. [CONFIGURATION.md](./CONFIGURATION.md)
+4. [THEMING.md](./THEMING.md)
+
+### Advanced
+1. [README - Core Capabilities](../README.md#-core-capabilities)
+2. [README - Integration Patterns](../README.md#-integration-patterns)
+3. [README - Error Handling](../README.md#-error-handling)
+4. [README - Performance](../README.md#-performance--best-practices)
+5. [PROXY.md](./PROXY.md)
+
+---
+
+**Last updated:** October 2025  
+**SDK Version:** 2.x+  
+**Documentation Version:** 2.0
+
+
+---
+
+For questions or documentation feedback, contact your LiquidCommerce representative.