Some more documentation please!
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
The issue names no files, tests, or entry points. Start by reviewing the existing long code example and the public API to identify which concepts are confusing. Done means the API is documented clearly enough that a newcomer can understand how to use Remutable.
Written by the indexing model from the issue text.
Description
I saw Remutable a while ago, and I kind of didn't get it. I didn't have the time to read through the long code example then.
Now that I see it again, It actually looks really awesome. But the actual API is still a little confusing. Would love more documentation on this.
Thanks!
- Dominant language
- JavaScript
- Stars
- 220
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·