react-email
react-email copied to clipboard
feat(docs): Add LLM-friendly API documentation
Description
This PR adds comprehensive LLM-friendly API documentation for the React Email component library. The new llm.md file provides structured documentation optimized for AI/LLM consumption and developer reference.
What's included
- Complete API reference for all React Email components
- TypeScript interfaces and prop definitions
- Import statements and usage examples
- Component descriptions optimized for AI tools and developers
- Structured format that's easy to parse and understand
Benefits
- Helps developers quickly understand component APIs
- Enables AI tools to better assist with React Email development
- Provides a single source of truth for component documentation
- Improves developer experience with clear, concise reference material
Type of change
- [x] Documentation update
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
Testing
- [x] Documentation has been reviewed for accuracy
- [x] All component APIs are properly documented
- [x] TypeScript interfaces are correctly represented
A developer on Askdev.AI requested this update