Skip to content
  • Latha Hariharan's avatar
    7045b89d
    Improve new user onboarding routing in README · 7045b89d
    Latha Hariharan authored
    
    
    Added clear routing for first-time users vs developers vs production:
    
    ## Changes to README.md
    
    **Top callout:**
    - Added prominent link to QUICKSTART.md at top of file
    - Clear time estimate: "< 1 hour: Docker setup → modernize first file"
    
    **Quick Start section restructured:**
    - Split into clear paths: "Just want to run" vs "Want to develop"
    - First-time path: cp .env.quickstart → docker compose up
    - Developer path: Links to docs/onboarding + learning guides
    - Added troubleshooting section with top 3 issues
    
    **Prerequisites reorganized by use case:**
    - Containerized evaluation (simplest): Docker + Ollama + 16 GB RAM
    - Development: Above + Python + Poetry + Node.js
    - Production: LiteLLM proxy or cloud APIs
    
    **Environment file clarity:**
    - .env.quickstart (23 lines) → First run / Evaluation
    - .env.example (900+ lines) → Production / Advanced
    - Explicit notes in both paths
    
    **Troubleshooting section added:**
    - Services won't start / OOM → Increase Docker memory to 16 GB
    - Ollama connection failed → host.docker.internal (Win/Mac) vs 172.17.0.1 (Linux)
    - Model memory error → Use smaller model or increase Docker memory
    - Links to full troubleshooting guides
    
    ## Changes to .env.example
    
    Added routing comment at top:
    - First run / Evaluation? → Use .env.quickstart
    - Production / Advanced? → Use this file
    
    ## Changes to .env.quickstart
    
    Updated header comments:
    - Clarified: "first-time setup and evaluation"
    - Added: "For production/advanced: use .env.example"
    
    ## Impact
    
    New users now have clear routing based on intent:
    - Evaluating AMP → QUICKSTART.md + .env.quickstart
    - Developing on AMP → docs/onboarding + .env.example
    - Deploying to prod → docs/deployment + .env.example
    
    Addresses confusion from Kumar's team onboarding where README pointed
    to .env.example (overwhelming) instead of .env.quickstart (minimal).
    
    Co-Authored-By: default avatarClaude Sonnet 4.5 <noreply@anthropic.com>
    7045b89d
    Improve new user onboarding routing in README
    Latha Hariharan authored
    
    
    Added clear routing for first-time users vs developers vs production:
    
    ## Changes to README.md
    
    **Top callout:**
    - Added prominent link to QUICKSTART.md at top of file
    - Clear time estimate: "< 1 hour: Docker setup → modernize first file"
    
    **Quick Start section restructured:**
    - Split into clear paths: "Just want to run" vs "Want to develop"
    - First-time path: cp .env.quickstart → docker compose up
    - Developer path: Links to docs/onboarding + learning guides
    - Added troubleshooting section with top 3 issues
    
    **Prerequisites reorganized by use case:**
    - Containerized evaluation (simplest): Docker + Ollama + 16 GB RAM
    - Development: Above + Python + Poetry + Node.js
    - Production: LiteLLM proxy or cloud APIs
    
    **Environment file clarity:**
    - .env.quickstart (23 lines) → First run / Evaluation
    - .env.example (900+ lines) → Production / Advanced
    - Explicit notes in both paths
    
    **Troubleshooting section added:**
    - Services won't start / OOM → Increase Docker memory to 16 GB
    - Ollama connection failed → host.docker.internal (Win/Mac) vs 172.17.0.1 (Linux)
    - Model memory error → Use smaller model or increase Docker memory
    - Links to full troubleshooting guides
    
    ## Changes to .env.example
    
    Added routing comment at top:
    - First run / Evaluation? → Use .env.quickstart
    - Production / Advanced? → Use this file
    
    ## Changes to .env.quickstart
    
    Updated header comments:
    - Clarified: "first-time setup and evaluation"
    - Added: "For production/advanced: use .env.example"
    
    ## Impact
    
    New users now have clear routing based on intent:
    - Evaluating AMP → QUICKSTART.md + .env.quickstart
    - Developing on AMP → docs/onboarding + .env.example
    - Deploying to prod → docs/deployment + .env.example
    
    Addresses confusion from Kumar's team onboarding where README pointed
    to .env.example (overwhelming) instead of .env.quickstart (minimal).
    
    Co-Authored-By: default avatarClaude Sonnet 4.5 <noreply@anthropic.com>
Loading