AdaCore / AdaCore/Ada_Drivers_Library
Improve user documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Ada
- Stars
- 286
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
Hello, is it possible to provide some documentation for the library? I tried to launch an SPI on stm32f4-discovery board, but I wasn't succeed. And I don't know, how the library should be used. I saw several examples, but they are not enough for a beginner in Ada to start using this library.
Contributor guide
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
Review the existing examples and the STM32F4-Discovery SPI use case first. Define beginner-oriented documentation that explains how to use the library and how to launch an SPI application on that board. Done means a beginner can follow the documented steps without needing to infer missing usage details.
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
- Needs clarification
- Newbie friendliness
- 25/100