platformio / platformio/platformio-docs
[Enhancement] Driver installation guide for each developpement board
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 285
- Forks
- 357
- PR merge metrics
- No merged PRs in 30d
Description
From what I saw, PlatformIO core installs some drivers automatically and other ones have to be installed manually.
I think one of the remaining problem of the documentation is that we don't understand well which driver to install which one we don't have to install.
For example, for Adafruit HUZZAH32, the adafruit website says that we have to install this driver:
but when we use it trough platformio, it seems that this driver is not necessary, and we don't know what to do with this information from adafruit.
So what I suggest is a driver installation guide for each cardboard who says which drivers we have to install and which driver is already installed or not necessary.
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 PlatformIO Core's driver installation behavior and the Adafruit HUZZAH32 example described in the issue. Define the board-by-board scope and verify which drivers are automatic versus manual; done means the documentation clearly tells users what to install for each development board.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100