community-rule/docs

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/)

• content-creation.md - Guide for creating blog content

Quick Navigation

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 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