Fix SDK version mismatch in oxide-sdk README

Open Beginner friendly
#13 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
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

Open oxide-sdk/README.md and compare its dependency version with oxide-sdk/Cargo.toml. Update the README dependency guidance so it reflects the current crate version or clearly points users to the current published version. Done when new developers no longer copy the outdated 0.1 version.

Written by the indexing model from the issue text.

Description

documentation good first issue

Description

The oxide-sdk/README.md tells users to add oxide-sdk = "0.1" to their Cargo.toml, but the actual crate version in oxide-sdk/Cargo.toml is 0.2.1. New developers copying the README snippet will get the wrong version.

What to fix

  • Update the version string in oxide-sdk/README.md to match the current version in oxide-sdk/Cargo.toml
  • Consider using a placeholder like oxide-sdk = "0.2" or linking to crates.io instead of hard-coding a version

Files involved

  • oxide-sdk/README.md
  • oxide-sdk/Cargo.toml (reference only)

Difficulty

Beginner — single-line documentation fix. Great for your first contribution!

Dominant language
Rust
Stars
33
Forks
9
Avg merge
5h 53m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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 niklabh/oxide

All issues in niklabh/oxide

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.