Welcome to the complete documentation for Table Generator! This index will help you find the right documentation for your needs.
For end users - Complete step-by-step instructions on how to use the application.
What you'll find:
- Getting started guide
- Creating and editing tables
- Using drag & drop functionality
- Mobile usage tips
- Troubleshooting common issues
- Keyboard shortcuts
Best for: New users, end users, support teams
For developers - Technical reference for all components, Redux store, and utilities.
What you'll find:
- Component props and interfaces
- Redux actions and state structure
- TypeScript type definitions
- Usage examples and code snippets
- Hook documentation
Best for: Frontend developers, contributors, integrators
For developers - High-level system design and architectural decisions.
What you'll find:
- Component architecture overview
- State management patterns
- Performance optimization strategies
- Security considerations
- Future improvement plans
Best for: Architects, senior developers, code reviewers
For DevOps and developers - Complete deployment instructions for all platforms.
What you'll find:
- Platform-specific deployment (Netlify, Vercel, GitHub Pages)
- Docker containerization
- AWS S3 + CloudFront setup
- CI/CD pipeline configuration
- Security and performance optimization
Best for: DevOps engineers, deployment teams, system administrators
- Start with User Guide
- Try the application
- Refer back to User Guide for specific features
- Read Architecture Guide for system overview
- Check API Documentation for component details
- Review README.md for setup instructions
- Read Deployment Guide
- Choose your target platform
- Follow platform-specific instructions
- Start with API Documentation
- Review Architecture Guide for system understanding
- Check README.md for project setup
Project overview, quick start, and basic information.
Dependencies, scripts, and project metadata.
TypeScript compiler settings and project configuration.
Build tool configuration and optimization settings.
External links to official documentation, community resources, and development tools.
- User Interface: User Guide
- Component Development: API Documentation
- System Design: Architecture Guide
- Deployment: Deployment Guide
- Project Setup: README.md
- End User: User Guide
- Frontend Developer: API Documentation + Architecture Guide
- DevOps Engineer: Deployment Guide
- Project Manager: README.md + Architecture Guide
- Learning the app: User Guide
- Adding features: API Documentation + Architecture Guide
- Deploying: Deployment Guide
- Contributing: README.md + Architecture Guide
If you find issues or want to improve the documentation:
- User Guide: Update USER_GUIDE.md for user-facing changes
- API Docs: Update API.md for technical changes
- Architecture: Update ARCHITECTURE.md for system changes
- Deployment: Update DEPLOYMENT.md for deployment changes
- User Issues: Check User Guide troubleshooting section
- Technical Issues: Check API Documentation and Architecture Guide
- Deployment Issues: Check Deployment Guide
- General Questions: Check README.md or create a GitHub issue
Last updated: August 2025 Documentation version: 1.0