mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2026-05-14 02:20:40 +00:00
eb8f7ae9d6
- Update multiple components with improved signal management and error handling - Add integration tests for dialog, popover, dropdown-menu, command, and sheet components - Enhance form validation with comprehensive type system - Add visual testing infrastructure with Playwright - Add analytics package for component tracking - Improve lazy loading with new component browser - Enhance error boundary with context and new_york variants - Update tailwind-rs-core with improved responsive utilities - Add extensive error handling utilities across packages Co-Authored-By: Claude <noreply@anthropic.com>
Leptos ShadCN UI Documentation
Welcome to the comprehensive documentation for the Leptos ShadCN UI component library. This documentation is organized to help you find the information you need quickly, whether you're just getting started or working on advanced features.
📚 Documentation Structure
🚀 Getting Started
Perfect for newcomers to the project:
🏗️ Architecture
Deep dive into the technical design:
- Design Decisions - Architecture Decision Records (ADRs)
- Migration Guides - Version upgrade guides
- Coverage Analysis - Test coverage documentation
- Performance Analysis - Performance benchmarks and optimization
- Performance Optimization Guide - Comprehensive optimization strategies
- Profiling Quick Reference - Fast profiling techniques
- Optimization Patterns Cookbook - Real-world optimization patterns
- Measurement & Benchmarking Guide - Performance measurement techniques
🧩 Components
Component library reference:
- API Reference
- Examples
- Accessibility Guide
- Theming Guide
- Mobile Design Guidelines - Responsive design patterns and best practices
🎓 Tutorials
Step-by-step video and written tutorials:
- Getting Started Series - Installation, first component, forms, theming
- Component Series - Form components, layouts, navigation
- Advanced Patterns - State management, validation, performance
- Video Production Guide - Create your own tutorials
🧪 Testing
Comprehensive testing documentation:
📦 Releases
Release management and version history:
🗺️ Roadmap
Project planning and future direction:
🤝 Contributing
How to contribute to the project:
🎯 Quick Navigation
For New Users
- Start with Getting Started
- Watch the Video Tutorials
- Try the Basic Examples
- Read the Component API Reference
For Developers
- Review Architecture Overview
- Check Testing Guidelines
- Follow Contributing Guidelines
- Explore Performance Optimization Guide for best practices
For Maintainers
- Understand Release Process
- Review Roadmap
- Check Performance Benchmarks
- Review Measurement & Benchmarking Guide for continuous monitoring
🔗 External Resources
- GitHub Repository: leptos-shadcn-ui
- Crates.io: leptos-shadcn-ui
- Leptos Documentation: leptos.dev
- ShadCN UI: ui.shadcn.com
📝 Documentation Standards
This documentation follows these principles:
- User-focused: Organized by user journey and needs
- Comprehensive: Covers all aspects of the project
- Up-to-date: Regularly maintained and reviewed
- Accessible: Clear language and good structure
- Searchable: Well-organized with clear navigation
🤝 Contributing to Documentation
We welcome contributions to improve this documentation! Please see our Contributing Guidelines for details on how to:
- Report documentation issues
- Suggest improvements
- Submit documentation updates
- Follow our writing standards
Last updated: September 2025