Feature Request: Add practical usage examples to documentation
- Dominant language
- TypeScript
- Stars
- 172
- Forks
- 207
- Avg merge
- 49m
- Merged PRs (30d)
- 1
Description
### Is your feature request related to a problem? Please describe.
While the API documentation is clear and well-structured, it can be difficult to understand how to apply it in real-world scenarios.
At the moment, most sections focus on individual endpoints or features, but there is limited guidance on how they are typically used together in practice. This makes it harder to quickly move from understanding the API to actually building something with it.
### Describe the solution you'd like
It would be very helpful to include more practical, real-world usage examples in the documentation.
For example:
- Common developer workflows (e.g. initializing, interacting, and completing a transaction flow)
- Integration scenarios (e.g. connecting a wallet, sending transactions, handling responses)
- End-to-end examples that demonstrate how multiple parts of the API work together
These examples could be added as dedicated sections or embedded within existing documentation pages.
### Describe alternatives you've considered
As a workaround, I tried exploring existing examples in the repository and external resources. However, these are either limited or not directly connected to the documentation, which makes them harder to discover and follow.
Having official examples directly in the documentation would be much more efficient and user-friendly.
### Additional context
Even a small number of well-structured examples could significantly improve the developer experience, especially for new users.
This would help bridge the gap between understanding the API and using it effectively in real projects.
Contributor guide
Research direction
No documentation files or tests are named. Start by locating the API documentation and existing repository examples, then identify a small set of related workflows to document. Done means the selected examples are directly discoverable in the documentation and show complete, realistic API usage from initialization through responses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100