Docs Phase 4: Reference Documentation

[joshrotenberg]

Part of #243

Goal

Create comprehensive reference documentation that can be auto-generated where possible.

Tasks

• CLI Reference
  • Auto-generate complete command list from CLI help
  • Document all global options
  • Document exit codes and error handling
  • Create command index/search functionality
• Environment Variables
  • Complete list of all environment variables
  • Document precedence rules
  • Provide examples for common setups
• Configuration File
  • Document complete schema
  • Provide example configurations
  • Document profile management
  • Explain environment variable expansion
• API Reference
  • Document raw API access
  • Request/response formats
  • Authentication methods
  • Rate limiting and quotas
• Troubleshooting Guide
  • Common error messages and solutions
  • Debug logging configuration
  • Network connectivity issues
  • Authentication problems

Success Criteria

• Reference docs are comprehensive and searchable
• Auto-generation keeps docs in sync with code
• Every configuration option is documented
• Users can self-diagnose most issues

[joshrotenberg]

Completed in PR #255 - comprehensive reference documentation has been added including API reference, troubleshooting guide, best practices, and configuration file reference.