particle-iot / particle-iot/docs
How can we document objects in Firmware?
Open
Nobody has claimed this yet.
tooling
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
I was trying to use WiFi.scan -- and it mentions "WiFiAccessPoint", but that object and its properties aren't in our documentation anywhere. I can grep our firmware to find the answer, but this seems like maybe something that could be in a reference document somewhere?
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 with the WiFi.scan documentation and search the firmware for WiFiAccessPoint, including its properties. Done means adding a reference entry that documents the object and its properties, with the WiFi.scan documentation linking to it where appropriate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100