Documentation

Open
#5 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start by reviewing the existing svdtools documentation and comparing it with the documentation in stm32-rs. Identify what should be moved and improved, then confirm that the resulting documentation is complete and up to date.

Written by the indexing model from the issue text.

Description

documentation enhancement help wanted

Move and improve the documentation from stm32-rs.

Dominant language
Rust
Stars
123
Forks
41
PR merge metrics
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/svdtools

All issues in rust-embedded/svdtools

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.