particle-iot / particle-iot/docs
As a firmware developer, I'd like to know what resources are used by the system
Open
Nobody has claimed this yet.
firmware
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
Documentation for which resources are used by our system firmware, and when would be useful for firmware developers that are talking to the bare metal directly.
- flash memory use
- SRAM memory use
- peripherals (e.g.. Timers, GPIOs.)
- etc..
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 repository’s existing firmware documentation and determine how flash memory, SRAM, and peripherals such as timers and GPIOs are currently described. Inventory the resources and when they are used, then document the results in the relevant documentation area. Done means firmware developers can identify the system resources and their usage.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100