mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2025-12-22 22:00:00 +00:00
0988aed57e
- Complete documentation reorganization into professional structure - Achieved 90%+ test coverage across all components - Created sophisticated WASM demo matching shadcn/ui quality - Fixed all compilation warnings and missing binary files - Optimized dependencies across all packages - Professional code standards and performance optimizations - Cross-browser compatibility with Playwright testing - New York variants implementation - Advanced signal management for Leptos 0.8.8+ - Enhanced testing infrastructure with TDD approach
4.1 KiB
4.1 KiB
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
🧩 Components
Component library reference:
🧪 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
- Try the Basic Examples
- Read the Component API Reference
For Developers
- Review Architecture Overview
- Check Testing Guidelines
- Follow Contributing Guidelines
For Maintainers
- Understand Release Process
- Review Roadmap
- Check Performance Benchmarks
🔗 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