adilallo
66 lines
2.5 KiB
Markdown
66 lines
2.5 KiB
Markdown
# Documentation Index
|
|
|
|
This directory contains all project documentation organized by topic.
|
|
|
|
## 📚 Documentation Structure
|
|
|
|
### Guides (`guides/`)
|
|
|
|
Comprehensive guides for different aspects of the project:
|
|
|
|
#### Testing
|
|
- **[testing.md](./guides/testing.md)** - Complete testing strategy and philosophy
|
|
- **[testing-framework.md](./guides/testing-framework.md)** - Detailed testing framework documentation
|
|
- **[testing-quick-reference.md](./guides/testing-quick-reference.md)** - Quick reference for daily development
|
|
- **[visual-regression.md](./guides/visual-regression.md)** - Visual regression testing guide
|
|
|
|
#### Performance
|
|
- **[performance.md](./guides/performance.md)** - Performance optimization and monitoring guide
|
|
|
|
#### Content
|
|
- **[content-creation.md](./guides/content-creation.md)** - Content creation guidelines
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
### For New Team Members
|
|
1. Start with **[testing.md](./guides/testing.md)** to understand the testing strategy
|
|
2. Use **[testing-quick-reference.md](./guides/testing-quick-reference.md)** for daily development
|
|
3. Reference **[performance.md](./guides/performance.md)** for performance optimization
|
|
|
|
### For Daily Development
|
|
- **[testing-quick-reference.md](./guides/testing-quick-reference.md)** - Essential commands and troubleshooting
|
|
- **[testing-framework.md](./guides/testing-framework.md)** - Detailed testing explanations
|
|
|
|
### For Specific Topics
|
|
- **Visual Testing**: [visual-regression.md](./guides/visual-regression.md)
|
|
- **Performance**: [performance.md](./guides/performance.md)
|
|
- **Content**: [content-creation.md](./guides/content-creation.md)
|
|
|
|
## 📊 Current Project Status
|
|
|
|
- **Unit Tests**: 94.88% coverage (exceeds 85% target)
|
|
- **Integration Tests**: 5 comprehensive test suites
|
|
- **E2E Tests**: 92 tests across 4 browsers
|
|
- **Visual Regression**: 23 tests per browser
|
|
- **Accessibility**: WCAG 2.1 AA compliance
|
|
- **Performance**: Lighthouse CI with budgets
|
|
- **Bundle Analysis**: Real-time monitoring with budgets
|
|
- **Web Vitals Tracking**: Core Web Vitals collection
|
|
|
|
## 🔄 Documentation Updates
|
|
|
|
This documentation is maintained by the CommunityRule development team and updated regularly.
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Vitest Documentation**: https://vitest.dev/
|
|
- **Playwright Documentation**: https://playwright.dev/
|
|
- **React Testing Library**: https://testing-library.com/
|
|
- **Lighthouse CI**: https://github.com/GoogleChrome/lighthouse-ci
|
|
- **Next.js Documentation**: https://nextjs.org/docs
|
|
|
|
---
|
|
|
|
**Last Updated**: January 2025
|
|
**Maintained by**: CommunityRule Development Team
|