jackfirth / jackfirth/resyntax
Grimoire docs need examples
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
The various module API reference docs in the Resyntax Grimoire don't use @examples anywhere. They should, like the other sections of the Resyntax docs do.
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 locating the module API reference docs in the Resyntax Grimoire and compare them with other Resyntax documentation sections that already use @examples. Add appropriate examples to the relevant API references, then verify that each changed documentation section renders and demonstrates its API as intended.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100