UNPKG

@tamyla/ui-components-react

Version:

React-based UI component library with Factory Bridge pattern - integrates seamlessly with @tamyla/ui-components. Enhanced AI agent discoverability with structured component registry, comprehensive Storybook (8 components), and detailed guides.

85 lines (62 loc) 3.63 kB
# Documentation Index - React Components This directory contains all documentation for the React components package, organized by category for better maintainability and clarity. ## Directory Structure ### `certification/` Component certification reports and validation data: - `COMPONENT_CERTIFICATION.json` - Component certification data - `COMPREHENSIVE_REACT_CERTIFICATION_REPORT.md` - Comprehensive certification report - `COMPREHENSIVE_REACT_CERTIFICATION.json` - Certification validation data ### `deployment/` Deployment-related documentation and reports: - `DEPLOYMENT_CONFIRMATION.md` - Deployment confirmation documentation - `DEPLOYMENT_READY.md` - Deployment readiness checklist - `deployment-fix-report.json` - Deployment fix reports and data ### `factory/` Factory system and bridge-related documentation: - `DASHBOARD_FACTORY_ENHANCEMENTS.md` - Dashboard factory enhancements - `FACTORY_STANDARDIZATION_COMPLETE.md` - Factory standardization completion - `ORGANIZED_BRIDGE_SUCCESS.md` - Bridge organization success report ### `github/` GitHub-related setup and configuration documentation: - `GITHUB_SECRETS_SETUP.md` - GitHub secrets setup guide ### `guides/` General guides and library documentation: - `API_REFERENCE.md` - Comprehensive component API documentation - `COMPONENT_DISCOVERY_GUIDE.md` - AI agent component discovery guide - `DESIGN_TOKENS_GUIDE.md` - Structured design tokens reference - `HYBRID_COMPONENT_LIBRARY_README.md` - Hybrid component library guide - `MIGRATION_GUIDE.md` - Component migration patterns - `STORYBOOK_GUIDE.md` - Interactive component development guide - `TROUBLESHOOTING.md` - Common issues and solutions - `TYPESCRIPT_NAVIGATION_GUIDE.md` - TypeScript definitions navigation ### `reports/` General reports and analysis documentation (currently empty, available for future use) ## Usage ### Certification Documentation Review the files in the `certification/` directory to understand component certification status and validation results. ### Deployment Documentation Use the files in the `deployment/` directory for deployment planning and troubleshooting. ### Factory Documentation Refer to the `factory/` directory for factory system architecture and bridge implementation details. ### GitHub Setup Follow the guides in the `github/` directory for GitHub integration and CI/CD setup. ### General Guides Read the documentation in the `guides/` directory for library usage and integration guides. ## Related Documentation - **Package README**: Main package documentation in the root directory - **Examples**: Interactive examples in the `examples/` directory - **Scripts**: Build and utility scripts in the `scripts/` directory - **Tests**: Test documentation in the `test/` directory ## Contributing to Documentation When adding new documentation: 1. **Choose the appropriate category** based on the documentation type 2. **Use descriptive filenames** that clearly indicate the content 3. **Follow Markdown format** for text documents 4. **Use JSON format** for structured data and reports 5. **Update this index** when adding new documentation ## File Naming Convention - Use descriptive names that indicate the documentation purpose - Use kebab-case for filenames (e.g., `deployment-ready.md`) - Include relevant keywords for searchability - Use appropriate file extensions (.md for Markdown, .json for data) This documentation structure ensures comprehensive coverage of all aspects of the React components package while maintaining organization and discoverability.