Add code samples
Open
Nobody has claimed this yet.
enhancement
specification
- Dominant language
- Go
- Stars
- 323
- Forks
- 133
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Description
One code sample for Node.js and Go for each operation would be a great addition to the documentation.
If we were to use Redoc (#182), this can be done using x-code-samples.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the API documentation and issue #182, then read Redoc's x-code-samples guidance linked in this issue. Add one Node.js and one Go sample for each operation; done means every documented operation has both examples in the chosen documentation format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, node.js
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100