You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description
The current README is very thorough and well-structured, especially for advanced and production use cases (streaming, retries, logging, custom fetch, proxies, etc.). However, for first-time users, the initial onboarding can feel overwhelming due to the amount of detailed information presented early on.
Adding a short Quick Start section at the top would significantly improve usability for new developers while keeping the rest of the documentation unchanged.
Proposed Improvement
Add a Quick Start section near the top of the README that includes:
Minimal installation command
Environment variable setup for GRADIENT_MODEL_ACCESS_KEY
Description
The current README is very thorough and well-structured, especially for advanced and production use cases (streaming, retries, logging, custom fetch, proxies, etc.). However, for first-time users, the initial onboarding can feel overwhelming due to the amount of detailed information presented early on.
Adding a short Quick Start section at the top would significantly improve usability for new developers while keeping the rest of the documentation unchanged.
Proposed Improvement
Add a Quick Start section near the top of the README that includes:
Example:
Why This Matters
I’d be happy to open a PR implementing this Quick Start section if the maintainers agree with the approach.
hacktoberfest'25