Docs refer to wrong version of embedded_hal
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Open the linked Adc documentation and inspect its implementations section and the embedded_hal reference it generates. Confirm that Channel is from embedded_hal 0.2, update the documentation link so it resolves to that version, and verify the published URL no longer returns 404.
Written by the indexing model from the issue text.
Description
The Adc struct of embassy_rp implements Channel from embedded_hal 0.2 but the URL in the docs points to 1.0.0-alpha.9 and once clicked it shows 404.
https://docs.embassy.dev/embassy-rp/git/rp2040/adc/struct.Adc.html#implementations
- Dominant language
- Rust
- Stars
- 3
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from embassy-rs/docserver
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
embassy-rs/docserver#8 ·
All issues in embassy-rs/docserver
Similar issues
-
bug: workspace access hint suggests a --subject command that fails for hyphen-leading OIDC subjectsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
A-FFI C-Testing D-Straightforward S-Ready
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
docs priority:P3 size:XS
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Appimage ConventionsOpenenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day