contactually / contactually/redux-capacitor
Needs API Documentation.
Open
enhancement
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We should use documentationjs or a similar library to document:
- the `entities` HOC and `containerPropTypes`
- all exports from the `modules` directory
This goes hand-in-hand with #15
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the source for the `entities` HOC, `containerPropTypes`, and every export in the `modules` directory, then review the related work in #15. Determine whether documentationjs or a similar library fits the project. Done means the listed API surfaces have generated, usable documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100