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
100 lines
4.1 KiB
Markdown
100 lines
4.1 KiB
Markdown
# 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](./getting-started/README.md)
|
|
Perfect for newcomers to the project:
|
|
- [Installation Guide](./getting-started/installation.md)
|
|
- [Your First Component](./getting-started/first-component.md)
|
|
- [Basic Examples](./getting-started/examples/)
|
|
- [Signal Management Examples](./getting-started/signal-management-examples.md)
|
|
|
|
### 🏗️ [Architecture](./architecture/README.md)
|
|
Deep dive into the technical design:
|
|
- [Design Decisions](./architecture/design-decisions/) - Architecture Decision Records (ADRs)
|
|
- [Migration Guides](./architecture/migration-guides/) - Version upgrade guides
|
|
- [Coverage Analysis](./architecture/coverage/) - Test coverage documentation
|
|
- [Performance Analysis](./architecture/performance/) - Performance benchmarks and optimization
|
|
|
|
### 🧩 [Components](./components/README.md)
|
|
Component library reference:
|
|
- [API Reference](./components/api-reference/)
|
|
- [Examples](./components/examples/)
|
|
- [Accessibility Guide](./components/accessibility/)
|
|
- [Theming Guide](./components/theming/)
|
|
|
|
### 🧪 [Testing](./testing/README.md)
|
|
Comprehensive testing documentation:
|
|
- [Testing Strategy](./testing/test-strategy.md)
|
|
- [Unit Testing](./testing/unit-testing.md)
|
|
- [Integration Testing](./testing/integration-testing.md)
|
|
- [E2E Testing](./testing/e2e-testing.md)
|
|
- [TDD Implementation](./testing/tdd/)
|
|
|
|
### 📦 [Releases](./releases/README.md)
|
|
Release management and version history:
|
|
- [Changelog](./releases/changelog.md)
|
|
- [Release Notes](./releases/release-notes/)
|
|
- [Phase Completion Summaries](./releases/phase-completion/)
|
|
- [Publishing Process](./releases/publishing/)
|
|
|
|
### 🗺️ [Roadmap](./roadmap/README.md)
|
|
Project planning and future direction:
|
|
- [Version 1.0 Plan](./roadmap/v1.0-plan.md)
|
|
- [Market Positioning](./roadmap/market-positioning-2025.md)
|
|
- [Competitor Analysis](./roadmap/competitor-analysis-2024.md)
|
|
- [React/Next.js Comparison](./roadmap/react-nextjs-comparison-2025.md)
|
|
|
|
### 🤝 [Contributing](./contributing/README.md)
|
|
How to contribute to the project:
|
|
- [Development Setup](./contributing/development-setup.md)
|
|
- [Coding Standards](./contributing/coding-standards.md)
|
|
- [Pull Request Process](./contributing/pull-request-process.md)
|
|
- [Architecture Decision Records](./contributing/adr/)
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
### For New Users
|
|
1. Start with [Getting Started](./getting-started/README.md)
|
|
2. Try the [Basic Examples](./getting-started/examples/)
|
|
3. Read the [Component API Reference](./components/api-reference/)
|
|
|
|
### For Developers
|
|
1. Review [Architecture Overview](./architecture/README.md)
|
|
2. Check [Testing Guidelines](./testing/README.md)
|
|
3. Follow [Contributing Guidelines](./contributing/README.md)
|
|
|
|
### For Maintainers
|
|
1. Understand [Release Process](./releases/README.md)
|
|
2. Review [Roadmap](./roadmap/README.md)
|
|
3. Check [Performance Benchmarks](./architecture/performance/)
|
|
|
|
## 🔗 External Resources
|
|
|
|
- **GitHub Repository**: [leptos-shadcn-ui](https://github.com/your-org/leptos-shadcn-ui)
|
|
- **Crates.io**: [leptos-shadcn-ui](https://crates.io/crates/leptos-shadcn-ui)
|
|
- **Leptos Documentation**: [leptos.dev](https://leptos.dev)
|
|
- **ShadCN UI**: [ui.shadcn.com](https://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](./contributing/README.md) for details on how to:
|
|
- Report documentation issues
|
|
- Suggest improvements
|
|
- Submit documentation updates
|
|
- Follow our writing standards
|
|
|
|
---
|
|
|
|
*Last updated: September 2025* |