Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a set of examples references from the documentation #41

Open
devraj opened this issue May 7, 2024 · 0 comments
Open

Provide a set of examples references from the documentation #41

devraj opened this issue May 7, 2024 · 0 comments
Assignees
Milestone

Comments

@devraj
Copy link
Member

devraj commented May 7, 2024

Is your feature request related to a problem? Please describe.
It would be good to have runnable examples for the end user to be able to almost copy and paste and run on their console. Particularly when it comes to using the API client.

Describe the solution you'd like
Inspired by the developer experience provided by companies like Stripe who do an excellent job at providing accurate examples of runnable code.

While we reference examples in our documentation we should also maintain a folder of examples which the developers can vendor in.

Note that we have a strong set of tests that we can draw from and the cli demonstrates the use of most of the endpoints.

The aim of this is to extend these working examples and keep them in sync.

A point to consider is how we are going to keep these up to date as the project evolves.

Describe alternatives you've considered
NA

Additional context
See projects shillelagh for examples

@devraj devraj added this to the beta-1 milestone May 7, 2024
@devraj devraj self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant