We’d like to improve our developer experience by adding proper API docs and usage guides.
Tasks
Why
- Easier onboarding for contributors
- Clearer guidance for integrators using the library
- Helps us avoid repeated Q&A on the same usage pitfalls
Good First Issue?
Yes ✅ — great opportunity to:
- Explore our codebase
- Contribute in a non-intrusive but high-impact way
- Shape how others learn and use the project
If you’re new, start with Typedoc setup — it’s mostly configuration. Once that’s working, expand into documenting corner cases. Small PRs are welcome!
We’d like to improve our developer experience by adding proper API docs and usage guides.
Tasks
🔧 Setup Typedoc for API documentation
✍️ Create developer-friendly documentation:
Why
Good First Issue?
Yes ✅ — great opportunity to: