CommunityRule/community-rule

Files

T

History

adilallo 7b9101824a First pass on component refactor

2026-01-29 17:29:37 -07:00

..

First pass on component refactor

2026-01-29 17:29:37 -07:00

CUSTOM_HOOKS.md

First pass on component refactor

2026-01-29 17:29:37 -07:00

README.md

First pass on component refactor

2026-01-29 17:29:37 -07:00

TESTING_GUIDE.md

Update E2E tests and simplify performance tests

2026-01-28 18:22:59 -07:00

README.md

Documentation

This directory contains project documentation organized by topic.

Documentation Structure

Core Documentation

TESTING_GUIDE.md - Complete testing guide covering component tests, E2E tests, accessibility, and testing philosophy
CUSTOM_HOOKS.md - Documentation for all custom React hooks used in the project

Guides (`guides/`)

container-presentation-pattern.md - Container/Presentation pattern guide for component architecture
content-creation.md - Guide for creating blog content

For Testing

Start with 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 for:

Available custom hooks
Usage examples
API documentation

For Component Architecture

See 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 for:

How to create blog articles
Content guidelines
Contribution workflow

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