Grimoire docs need examples
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
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.
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.
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
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.
More from jackfirth/resyntax
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
testing
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
testing
Difficulty 3/5 1-2 days Newbie friendliness 75/100
-
testing
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
new lint
Difficulty 3/5 1-2 days Newbie friendliness 55/100
All issues in jackfirth/resyntax
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
certification
Difficulty 1/5 Under an hour Newbie friendliness 80/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
bisq-network/support#2181 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
tutorial updates Open
Difficulty 1/5 Under an hour Newbie friendliness 80/100
sveltejs/svelte.dev#2241 ·