Point to the new target docs

Open Beginner friendly
#370 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Open docs/intro/install.html and compare its Arm Cortex-M bare-metal target guidance with the updated Rust target documentation at doc.rust-lang.org/nightly/rustc/platform-support/arm-none-eabi.html. Done means the book links to the new target documentation instead of replicating its details.

Written by the indexing model from the issue text.

Description

https://doc.rust-lang.org/nightly/rustc/platform-support/arm-none-eabi.html has been updated to have detailed documentation for every Arm Cortex-M related bare-metal target.

We should link to that from https://docs.rust-embedded.org/book/intro/install.html rather than try and replicate it.

Dominant language
No language data
Stars
1.3k
Forks
223
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.