Welcome to the TutorBot documentation! This comprehensive guide covers everything you need to know about setting up, developing, and deploying TutorBot.
graph TB
Docs[TutorBot Documentation] --> Getting[Getting Started]
Docs --> Arch[Architecture & Setup]
Docs --> Dev[Development]
Docs --> Int[Integration]
Docs --> API[API Reference]
Docs --> Deploy[Deployment]
Docs --> Ref[Reference]
Getting --> G1[Quick Start Guide]
Getting --> G2[Environment Setup]
Getting --> G3[Docker Setup]
Getting --> G4[Chatwoot Setup]
Arch --> A1[Project Organization]
Arch --> A2[Planning Profiles]
Arch --> A3[Prefill Confirmation Flow]
Arch --> A4[Webhook System]
Arch --> A5[Age Verification]
Dev --> D1[Git Workflow]
Dev --> D2[Testing Structure]
Dev --> D3[Workflow Documentation]
Int --> I1[Integration Roadmap]
Int --> I2[Stripe Payment]
Int --> I3[WhatsApp Formatting]
API --> API1[Mocked Functions]
Deploy --> Dep1[Troubleshooting]
Ref --> R1[Documentation Structure]
Ref --> R2[Email Conventions]
Ref --> R3[Calendar Email Conventions]
style Docs fill:#e1f5ff
style Getting fill:#e8f5e9
style Arch fill:#fff4e1
style Dev fill:#f3e5f5
style Int fill:#fce4ec
flowchart TD
User[User Type?] --> New{New User?}
User --> Dev{Developer?}
User --> Deploy{Deploying?}
New -->|Yes| New1[1. Quick Start Guide]
New1 --> New2[2. Environment Setup]
New2 --> New3[3. Chatwoot Setup]
New3 --> NewDone[Ready to Use]
Dev -->|Yes| Dev1[1. Project Organization]
Dev1 --> Dev2[2. Planning Profiles]
Dev2 --> Dev3[3. Prefill Confirmation Flow]
Dev3 --> Dev4[4. Webhook System]
Dev4 --> Dev5[5. Git Workflow]
Dev5 --> Dev6[6. Testing Structure]
Dev6 --> DevDone[Ready to Develop]
Deploy -->|Yes| Dep1[1. Docker Setup]
Dep1 --> Dep2[2. Git Workflow]
Dep2 --> Dep3[3. Troubleshooting]
Dep3 --> DepDone[Ready to Deploy]
style New fill:#e8f5e9
style Dev fill:#fff4e1
style Deploy fill:#f3e5f5
- Start with Quick Start Guide
- Set up your Environment
- Configure Chatwoot
- Read Project Organization
- Understand Planning Profiles
- Review Prefill Confirmation Flow - Critical for WhatsApp menus
- Study Webhook System - Error handling and deduplication
- Follow the Git Workflow
- Check Testing Structure
- Use Docker Setup
- Follow Git Workflow
- Check Troubleshooting if issues arise
gitgraph
commit id: "Initial"
branch develop
checkout develop
commit id: "Setup"
branch feature/my-feature
checkout feature/my-feature
commit id: "Add feature"
commit id: "Fix bugs"
checkout develop
merge feature/my-feature
commit id: "Test on develop"
branch main
checkout main
merge develop
commit id: "Deploy to production"
# 1. Create feature branch
gitfeature my-feature
# 2. Make changes and commit
git add .
git commit -m "Add new feature"
# 3. Test on develop
gitmerge
# 4. Deploy to production
gitdeploy
¶ Quick Commands:
gitstatus - Check current statusgitfeature <name> - Create feature branchgitmerge - Merge to developgitdeploy - Safe deploy to production
When contributing to the documentation:
- Follow the existing structure
- Use clear, descriptive headings
- Include code examples where helpful
- Update this README if adding new sections
- Test all commands and examples
💡 Tip: Use the search function in your browser (Ctrl+F) to quickly find specific topics within each document.