mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2025-12-22 22:00:00 +00:00
feat: Initial release v0.1.0 - 52 Leptos ShadCN UI components
This commit is contained in:
54
docs/README.md
Normal file
54
docs/README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# 📚 ShadCN UI Documentation
|
||||
|
||||
> **Centralized documentation for the ShadCN UI project**
|
||||
|
||||
## 🗂️ **Documentation Structure**
|
||||
|
||||
### **🧪 Testing Documentation**
|
||||
- **[Testing Guide](testing/TESTING_GUIDE.md)** - Comprehensive E2E testing guide for dynamic loading systems
|
||||
- **Test Suites** - Located in `tests/e2e/` directory
|
||||
|
||||
### **🧩 Component Documentation**
|
||||
- **[Leptos Demo](components/leptos-demo.md)** - Enhanced lazy loading demo for Leptos book examples
|
||||
- **[Example Usage](components/example-usage.md)** - How to integrate the enhanced lazy loading system
|
||||
- **[Demo Features](components/DEMO_FEATURES.md)** - Overview of available features and capabilities
|
||||
- **[Distribution Guide](components/DISTRIBUTION_GUIDE.md)** - How to distribute and use the system
|
||||
|
||||
### **🚀 Development Documentation**
|
||||
- **[Setup Script](development/setup-for-other-projects.sh)** - Automated setup script for integrating the system
|
||||
- **[Development Guide](DEVELOPMENT.md)** - Project development guidelines and setup
|
||||
|
||||
## 🔍 **Quick Navigation**
|
||||
|
||||
### **For Developers**
|
||||
- Start with [DEVELOPMENT.md](../DEVELOPMENT.md) for project setup
|
||||
- Check [components/leptos-demo.md](components/leptos-demo.md) for component examples
|
||||
- Use [development/setup-for-other-projects.sh](development/setup-for-other-projects.sh) for integration
|
||||
|
||||
### **For Testers**
|
||||
- Read [testing/TESTING_GUIDE.md](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](components/example-usage.md) for integration
|
||||
- Review [components/DEMO_FEATURES.md](components/DEMO_FEATURES.md) for capabilities
|
||||
- Follow [components/DISTRIBUTION_GUIDE.md](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*
|
||||
Reference in New Issue
Block a user