Skip to content

Feature Request: Add practical usage examples to documentation #281

@tenet10101

Description

@tenet10101

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions