Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation formatting and link issues #1105

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

donatik27
Copy link

  1. bp256/README.md:
    Old: Rust **1.81* or higher.
    New: Rust **1.81** or higher.
    Reason: Fixes incorrect Markdown bold text formatting by adding the missing closing asterisk. This ensures proper rendering of the minimum Rust version requirement.

  2. primeorder/README.md:
    Old: [p521]: https://github.com/RustCrypto/elliptic-curves/tree/master/p384
    New: [p521]: https://github.com/RustCrypto/elliptic-curves/tree/master/p521
    Reason: Corrects the incorrect URL path for the p521 documentation link. The original link incorrectly pointed to p384 instead of p521, which could confuse users looking for p521 documentation.

Before:
image

After:
image

These changes improve documentation accuracy and ensure proper navigation within the project documentation.

Testing:

  • Verified Markdown formatting renders correctly
  • Confirmed the p521 link points to the correct directory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant