digidem / digidem/comapeo-core-react
Update Documentation
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 1
- Avg merge
- 5m
- Merged PRs (30d)
- 2
Description
Update API documentation and JSDOC annotations with the updated API
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 existing API documentation and JSDoc annotations in the TypeScript React wrapper, then compare them with the updated @comapeo/core API. Update the documentation and annotations so they match the current API; the issue does not name specific files or tests, so locating those entry points is part of the work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100