Shopify / Shopify/react-native-skia
Document imperative methods
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 8.6k
- Forks
- 647
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 35
Description
There is an increasing need to provide documentation for the imperative API: path and image methods for instance.
On top of that, by providing some sort of jsdoc integration, we might be able to use it as well for React components. Needs to be investigated.
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.
Research direction
Start by locating the imperative API entry points for the path and image methods and reviewing how React components are currently documented. Investigate whether JSDoc integration can support both areas; done means the imperative API is documented and the JSDoc approach has a clear, agreed scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, react-native
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100