adilallo
77 lines
2.3 KiB
Markdown
77 lines
2.3 KiB
Markdown
# Documentation
|
|
|
|
This directory contains project documentation organized by topic.
|
|
|
|
## Documentation Structure
|
|
|
|
### Core Documentation
|
|
|
|
- **[TESTING_GUIDE.md](./TESTING_GUIDE.md)** - Complete testing guide covering component tests, E2E tests, accessibility, and testing philosophy
|
|
- **[CUSTOM_HOOKS.md](./CUSTOM_HOOKS.md)** - Documentation for all custom React hooks used in the project
|
|
|
|
### Guides (`guides/`)
|
|
|
|
- **[container-presentation-pattern.md](./guides/container-presentation-pattern.md)** - Container/Presentation pattern guide for component architecture
|
|
- **[content-creation.md](./guides/content-creation.md)** - Guide for creating blog content
|
|
- **[i18n-translation-workflow.md](./guides/i18n-translation-workflow.md)** - Guide for working with translations and UI content management
|
|
|
|
## Quick Navigation
|
|
|
|
### For Testing
|
|
|
|
Start with **[TESTING_GUIDE.md](./TESTING_GUIDE.md)** for:
|
|
|
|
- Testing philosophy and approach
|
|
- Component testing with `componentTestSuite`
|
|
- E2E testing with Playwright
|
|
- Accessibility testing
|
|
- How to add tests for new components
|
|
|
|
### For Custom Hooks
|
|
|
|
See **[CUSTOM_HOOKS.md](./CUSTOM_HOOKS.md)** for:
|
|
|
|
- Available custom hooks
|
|
- Usage examples
|
|
- API documentation
|
|
|
|
### For Component Architecture
|
|
|
|
See **[container-presentation-pattern.md](./guides/container-presentation-pattern.md)** for:
|
|
|
|
- Container/Presentation pattern overview
|
|
- When and how to use the pattern
|
|
- Migration guide for existing components
|
|
- Best practices and examples
|
|
|
|
### For Content Creation
|
|
|
|
See **[content-creation.md](./guides/content-creation.md)** for:
|
|
|
|
- How to create blog articles
|
|
- Content guidelines
|
|
- Contribution workflow
|
|
|
|
### For Translations and UI Content
|
|
|
|
See **[i18n-translation-workflow.md](./guides/i18n-translation-workflow.md)** for:
|
|
|
|
- How to update UI text content
|
|
- Translation key structure and naming conventions
|
|
- How to extract strings from components
|
|
- How to add new translation keys
|
|
- Best practices for content creators and developers
|
|
|
|
## 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
|