We totally need "run this example" in the api docs
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Now that reqlite exists we should totally create a code-example widget for the api docs so people can play with the example code in the browser.
This would be unbelievably cool @mglukhovsky
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
Review the API documentation and the linked reqlite project first to understand the requested browser-based example experience. Define which examples should be runnable and what successful execution should show; the work is done when the agreed widget is integrated into the API docs and examples can be played with in the browser.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100