telefonicaid / telefonicaid/iotagent-node-lib
Improve function reference documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 90
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 1
Description
Current documentation of the functions provided by the library is really hard to read, and some effort should be put on making it more accessible for IoTAgent developers (dividing it into carefully sepparated sections, adding indexes, and so).
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
Locate the library's current function reference documentation and review how its sections are organized. Identify the function coverage and navigation available to IoTAgent developers; the work is done when the reference is divided into clear sections and includes useful indexes. No documentation file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100