broken rust docs

Open
#641 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
cryptography, documentation, release

Research direction

Start by comparing the Rust documentation for rsa 0.9.9 and 0.8.2 at the linked docs.rs and crates.io pages. Trace why those historical versions have broken docs, then determine the patch-version publishing steps needed to make the documentation available for both series.

Written by the indexing model from the issue text.

Description

Hi,

Rust Docs are broken for several previous versions of this crate, especially the 0.9 and 0.8 series.

https://docs.rs/crate/rsa/0.9.9

https://crates.io/crates/rsa/0.8.2

Would you kindly publish patch versions that fix the docs for these series? In order to help developers rewrite their code to migrate closer to the latest rsa crate version.

Dominant language
Rust
Stars
673
Forks
190
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 RustCrypto/RSA

All issues in RustCrypto/RSA

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.