jaredhanson / jaredhanson/electrolyte
Full API documentation?
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 555
- Forks
- 60
- PR merge metrics
- No merged PRs in 30d
Description
Can we get a full documentation about method and their descriptions that are exposed by electrolyte?
The quick start documentation doesn't explain the library in details (Example use, and node methods aren't very clear)
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 reviewing the existing quick start documentation and the methods and node methods exposed by electrolyte. Document the library's exposed methods, descriptions, and examples so the API and node methods are clear beyond the quick start.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100