mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2026-01-05 20:42:55 +00:00
- Refactored 6,741 lines across 10 large files into 55 focused modules - All modules now under 300 lines for better LLM comprehension and maintainability - Maintained full test coverage and functionality Files refactored: - packages/leptos/input/src/implementation_tests.rs (867 lines) → 6 modules - packages/leptos/form/src/implementation_tests.rs (783 lines) → 5 modules - packages/signal-management/src/signal_management_tests.rs (766 lines) → 7 modules - packages/signal-management/src/simple_tests.rs (753 lines) → 7 modules - packages/signal-management/src/lifecycle_tests.rs (648 lines) → 5 modules - packages/leptos/input/src/tdd_tests.rs (663 lines) → 6 modules - packages/leptos/command/src/tdd_tests.rs (607 lines) → 5 modules - packages/signal-management/src/memory_management_tests.rs (554 lines) → 5 modules - packages/signal-management/src/component_migration.rs (541 lines) → 4 modules - packages/leptos/button/src/tdd_tests.rs (560 lines) → 5 modules Added comprehensive remediation documentation in docs/remediation/ All tests passing - 132 tests for button component alone
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