Skip to content

DX: Add clear local development setup troubleshooting guide #129

@amartya69

Description

@amartya69

While setting up the project locally, it is not immediately clear how to troubleshoot common development issues such as large model downloads, environment mismatches, or failed startup.

Problem:

  • New contributors may struggle with initial setup.
  • Errors related to model downloads, memory limits, or missing dependencies are not clearly documented.
  • This increases the barrier to entry for first-time contributors.

Expected Improvement:

  • A dedicated troubleshooting section in the README or CONTRIBUTING guide.
  • Common errors and their fixes (e.g., memory issues, skipped model downloads, dev-lite usage).
  • Clear verification steps to confirm a successful local setup.

Why this matters:

  • Aligns with the ongoing "Increase Developer Experience" initiative.
  • Reduces onboarding friction for new contributors.
  • Helps contributors self-diagnose issues before opening support questions.

Suggested Scope:

  • Documentation-only change (no functional code changes required).
  • Can be expanded incrementally.

I’d be happy to work on this issue and submit a PR if it’s approved.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions