leptos-shadcn-ui/docs/README.md

📚 ShadCN UI Documentation

Centralized documentation for the ShadCN UI project

🗂️ Documentation Structure

🧪 Testing Documentation

• Testing Guide - Comprehensive E2E testing guide for dynamic loading systems
• Test Suites - Located in tests/e2e/ directory

🧩 Component Documentation

• Leptos Demo - Enhanced lazy loading demo for Leptos book examples
• Example Usage - How to integrate the enhanced lazy loading system
• Demo Features - Overview of available features and capabilities
• Distribution Guide - How to distribute and use the system

🚀 Development Documentation

• Setup Script - Automated setup script for integrating the system
• Development Guide - Project development guidelines and setup

🔍 Quick Navigation

For Developers

• Start with DEVELOPMENT.md for project setup
• Check components/leptos-demo.md for component examples
• Use development/setup-for-other-projects.sh for integration

For Testers

• Read testing/TESTING_GUIDE.md for comprehensive testing
• Run tests from tests/e2e/ directory
• Use the automated test runner for dynamic loading systems

For Users

• Check components/example-usage.md for integration
• Review components/DEMO_FEATURES.md for capabilities
• Follow components/DISTRIBUTION_GUIDE.md for deployment

📝 Documentation Standards

• Keep it focused - One concept per document
• Include examples - Code snippets and usage patterns
• Stay current - Update when features change
• Cross-reference - Link between related documents

🚀 Contributing to Documentation

1. Add new docs to appropriate subdirectory
2. Update this index when adding new files
3. Keep it organized - follow the existing structure
4. Test examples - ensure code snippets work

---

Last updated: September 2025