Complete guide to all documentation files and when to use them.
Just starting? → README.md Ready to deploy? → DEPLOYMENT.md Site is live? → MAINTENANCE.md Want to make money? → BUSINESS_OPERATIONS.md Having issues? → TROUBLESHOOTING.md
Purpose: Project overview and quick start guide
Read this when:
- First discovering the project
- Evaluating if ToolForge AI is right for you
- Looking for quick start instructions
- Understanding the tech stack
Key sections:
- What is ToolForge AI?
- Quick start (5 steps)
- How it works
- Tech stack
- FAQ
Time to read: 10-15 minutes
Purpose: Step-by-step deployment to production
Read this when:
- Ready to deploy to Vercel
- Setting up Supabase database
- Configuring environment variables
- Setting up custom domain
- Configuring cron jobs
Key sections:
- Prerequisites checklist
- Supabase setup (with SQL)
- Environment variables
- Vercel deployment
- Domain configuration
- Cron job setup
- Testing deployment
- Troubleshooting deployment
Time to complete: 2-4 hours (first time)
Status: Already exists, comprehensive
Purpose: Daily, weekly, and monthly maintenance tasks
Read this when:
- Site is deployed and running
- Planning your maintenance schedule
- Wondering what to check daily
- Optimizing performance
- Backing up data
Key sections:
- Daily tasks (5 min)
- Check cron jobs
- Review email digest
- Approve tools
- Weekly tasks (30 min)
- Analytics review
- Affiliate performance
- Content quality check
- Database health
- Monthly tasks (1 hour)
- Deep analytics
- SEO audit
- Scraper maintenance
- Template updates
- Monitoring checklist
- Backup procedures
- Performance optimization
- Common issues and fixes
Time investment: 5 min daily, 30 min weekly, 1 hour monthly
Created: ✅ New comprehensive guide
Purpose: Complete business strategy and monetization guide
Read this when:
- Planning your launch
- Setting up LLC
- Applying to affiliate programs
- Tracking revenue
- Scaling your business
Key sections:
- Phase 0: Pre-Launch (1-2 weeks)
- Legal setup (LLC, EIN)
- Business banking
- Legal pages (privacy, terms, disclosure)
- Phase 1: Initial Seeding (2-4 weeks)
- Manual seeding (100-200 tools)
- Quality control
- SEO setup
- Phase 2: Growth Mode (2-3 months)
- Content expansion
- Affiliate acceleration
- Traffic growth
- Phase 3: Passive Mode (Ongoing)
- Automation setup
- Maintenance mode
- Revenue expectations
- Affiliate program applications
- Revenue tracking
- Legal requirements
- Tax considerations
- Scaling strategies
Timeline: Pre-launch to year 1+
Created: ✅ New comprehensive guide
Purpose: Complete list of AI tool affiliate programs
Read this when:
- Ready to join affiliate programs
- Looking for commission rates
- Comparing programs
- Creating application
Key sections:
- Top Tier Programs (30%+ commission)
- Jasper.ai, Writesonic, Leonardo.ai, etc.
- Mid Tier Programs (15-30% commission)
- Copy.ai, Notion, Grammarly, etc.
- Affiliate Networks
- Impact Radius
- ShareASale
- CJ Affiliate
- PartnerStack
- Application process
- Application template
- Best practices
- Link management
- Tracking & optimization
Programs listed: 20+ with details
Created: ✅ New comprehensive guide
Purpose: SEO and content creation strategy
Read this when:
- Planning content creation
- Doing keyword research
- Writing manual content
- Optimizing for SEO
- Growing organic traffic
Key sections:
- SEO keyword research
- Understanding intent
- Research process
- Keyword difficulty
- Long-tail keywords
- 100+ examples by category
- How to find them
- Content templates
- Tool review template (2,000 words)
- Comparison template (2,500 words)
- Best tools list template (3,500 words)
- How-to guide template (2,000 words)
- Publishing schedule
- Weekly content plan
- Monthly calendar
- Automation-first approach
- Quality checklist
- SEO optimization
- Internal linking
- User experience
- Evergreen vs trending content
- Internal linking strategy
- Content promotion
Created: ✅ New comprehensive guide
Purpose: Solutions to common issues
Read this when:
- Something isn't working
- Getting error messages
- Scrapers failing
- Database problems
- Performance issues
Key sections:
- Build and deployment errors
- Module not found
- Environment variables
- Build timeouts
- TypeScript errors
- Scraper issues
- 0 results
- Duplicate tools
- Invalid data
- Rate limiting
- Database problems
- Too many connections
- Slow queries
- Out of space
- Cron job failures
- Timeouts
- Not running
- Unauthorized errors
- Performance issues
- Slow page loads
- High memory usage
- API errors
- 500 errors
- 429 rate limiting
- Email problems
- Not sending
- Going to spam
- Authentication issues
Created: ✅ New comprehensive guide
Purpose: Future features and enhancements
Read this when:
- Curious about future plans
- Want to contribute
- Planning your roadmap
- Prioritizing features
Key sections:
- Phase 1: MVP (Completed)
- Phase 2: Growth Features
- Enhanced SEO (sitemap, schema)
- Search functionality
- Comparison tools
- User reviews
- Email newsletter
- Phase 3: Scale Features
- Performance optimization
- AI-enhanced reviews
- Sponsored listings
- Multi-language
- Phase 4: Advanced Features
- Premium membership
- API
- Community features
- Mobile app
- Nice-to-have features
- Technical debt
- Priority matrix
- Implementation timeline
Timeline: Next 12-24 months
Created: ✅ New comprehensive guide
Purpose: Deep dive into automation system
Read this when:
- Understanding automation architecture
- Customizing scrapers
- Debugging automation
- Adding new scrapers
Key sections:
- Overview and architecture
- Setup instructions
- Component details
- Scrapers (3)
- Content generation
- Email system
- Cron jobs
- Usage examples
- Manual operations
- Monitoring guide
- Customization guide
- Troubleshooting
- Performance tips
- Security best practices
Status: Already exists, comprehensive
Files:
- ADMIN_ARCHITECTURE.md
- ADMIN_DASHBOARD.md
- ADMIN_QUICKSTART.md
- ADMIN_SUMMARY.md
Purpose: Admin interface documentation
Read this when:
- Using admin dashboard
- Managing tools
- Approving content
- Viewing analytics
Status: Already exist
- README.md (10 min) - Understand what it is
- BUSINESS_OPERATIONS.md - Phase 0 (30 min) - Decide if you want to do this
- DEPLOYMENT.md (2-4 hours) - Set up and deploy
- MAINTENANCE.md - Daily tasks (5 min) - Bookmark this
- README.md (10 min) - Overview
- PROJECT_STRUCTURE.md (existing) - Architecture
- AUTOMATION.md (existing) - Deep dive
- ROADMAP.md - Future plans
- BUSINESS_OPERATIONS.md (1 hour) - Full guide
- AFFILIATE_PROGRAMS.md (30 min) - Monetization
- CONTENT_STRATEGY.md (30 min) - SEO
- DEPLOYMENT.md (2-4 hours) - Launch
- MAINTENANCE.md (bookmark) - Operations
- TROUBLESHOOTING.md - Find your issue
- MAINTENANCE.md - Check if maintenance needed
- AUTOMATION.md - Understand how it works
- GitHub Issues - Ask for help
Total Files: 15 Total Words: ~50,000 Total Pages: ~150 (if printed) Coverage: Complete - from setup to scale
New Files Created:
- ✅ README.md (enhanced)
- ✅ MAINTENANCE.md
- ✅ BUSINESS_OPERATIONS.md
- ✅ AFFILIATE_PROGRAMS.md
- ✅ CONTENT_STRATEGY.md
- ✅ TROUBLESHOOTING.md
- ✅ ROADMAP.md
- ✅ DOCUMENTATION_INDEX.md
Existing Files (Already Good):
- ✅ DEPLOYMENT.md
- ✅ AUTOMATION.md
- ✅ ADMIN_*.md files
- ✅ PROJECT_STRUCTURE.md
- ✅ QUICK_START.md
- Open GitHub issue
- Tag with "documentation"
- Specify which file and section
- Fork repo
- Edit markdown file
- Submit pull request
- Tag maintainers
- Actionable: Tell readers what to do
- Scannable: Use headers, bullets, code blocks
- Examples: Show, don't just tell
- Tested: All commands/code should work
- Updated: Include last updated date
Need to...
| Task | Document |
|---|---|
| Understand project | README.md |
| Deploy to production | DEPLOYMENT.md |
| Daily maintenance | MAINTENANCE.md → Daily Tasks |
| Join affiliate programs | AFFILIATE_PROGRAMS.md |
| Create content | CONTENT_STRATEGY.md |
| Fix an error | TROUBLESHOOTING.md |
| See future plans | ROADMAP.md |
| Start a business | BUSINESS_OPERATIONS.md |
| Understand automation | AUTOMATION.md |
| Use admin dashboard | ADMIN_QUICKSTART.md |
Future additions:
- Video tutorials (YouTube)
- Interactive setup wizard
- Case studies
- Code API documentation (JSDoc)
- Migration guides (v1 → v2)
- FAQ expansion
- Community cookbook (user recipes)
Last Updated: 2026-02-11
Have questions? Start with README.md and follow the reading order for your use case above.
Ready to get started? Begin with DEPLOYMENT.md!