docs: References should be intra-doc links

Open
#566 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Search the repository documentation for references that currently lead nowhere, then read the linked rustdoc guide on intra-doc links. Done means the applicable references use intra-doc links and rustdoc can check that their targets exist.

Written by the indexing model from the issue text.

Description

There are bunch of references that lead to nowhere so rustdoc doesn't check they exist.

It would be great maybe to turn them into intra-doc links so it gets complained when it ditto's.

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.