feat: MDBook linkcheck

[youyyytrok]

Hi! This pull request addresses the following changes:

• Fix broken links: Updated outdated or broken URLs in ghash.rs and gcm.rs to use the correct and secure NIST links.
• Formatting improvements: Resolved minor formatting inconsistencies in aes/README.md for better readability.

[youyyytrok]

@Autoparallel Hi! I closed my previous PR #189 and opened a new one with the latest changes. Please review it.

[Autoparallel]

Thanks @youyyytrok let me review!

[Autoparallel]

Thanks for these fixes!

In order to keep the contribution quality high, I want to ask a favor of you. Would you mind making a few more edits? Let me suggest some low hanging fruit:

If you visit: https://ronkathon.pluto.xyz you will find the landing page has a blurb on sumcheck that is a bit out of place. I believe this is also just the repo's README. Do you think you can reorganize this so that the landing page / README more adequately explains the project and keeps the specific material located in its relevant module/section/chapter?

I don't believe this would be too much more work. Hopefully you don't mind this ask!

[Autoparallel]

I also can propose this: #198

[youyyytrok]

Hi @Autoparallel !
I’ve added a link checker to the CI, but I used a different tool, namely lychee, instead of the MDBook you mentioned. If it’s important, I can switch to the one you described in the issue #198 .

Also, I couldn’t resolve the issue with the link https://www.cryptopp.com/wiki/XChaCha20, which is timing out.

I couldn’t find anything to replace it with. Could you help with this?

[Autoparallel]

@youyyytrok that link seems broken to me too. Interesting...

Perhaps you can find an alternative link for ChaCha20? I know there's some good ones out there. Give me a bit, let me run the CI here and see what we get.

[Autoparallel]

Here is this mdbook-linkcheck

Maybe we can add a workflow for this and set up the configuration for the book?

There is also just mdbook test that we can run in CI? Can you perhaps look into these two options as well?

I really appreciate the help here, by the way!

[Autoparallel]

Suggested change

	on:
	push:
	branches:
	- "**"
	on:
	pull_request:
	types: [opened, synchronize, reopened]
	push:
	branches: [main]

[Autoparallel]

Consider this to match other workflows we have!

[Autoparallel]

Perhaps you can have this walk through all the different markdown files we have? Then we can check links throughout the book too?

[youyyytrok]

Hi! @Autoparallel Pls check🐳

[youyyytrok]

I couldn't find a similar alternative to the original site. Perhaps using a link from the Web Archive would work for you.
If not, here are other options, though they don't provide information as concise and essential as the original site:

• XChaCha – IETF Draft
• XChaCha20-Poly1305 – Libsodium Docs

[Autoparallel]

@youyyytrok nice! Just curious, do we need lychee for checking links if we have mdbook-linkcheck?

Supposing not, then we need to make sure mdbook-linkcheck is ran on PRs into main. So perhaps we have a book-check workflow or something for this?

Is there a reason you prefer lychee?

[Autoparallel]

I couldn't find a similar alternative to the original site. Perhaps using a link from the Web Archive would work for you. If not, here are other options, though they don't provide information as concise and essential as the original site:

• XChaCha – IETF Draft
• XChaCha20-Poly1305 – Libsodium Docs

The web archive link is fine in my opinion!

I'm noticing two other links fail -- ones that go to our releases page on github. I deleted these since this crate is on crates.io. Perhaps we direct there instead?

[youyyytrok]

@youyyytrok nice! Just curious, do we need lychee for checking links if we have mdbook-linkcheck?

Supposing not, then we need to make sure mdbook-linkcheck is ran on PRs into main. So perhaps we have a book-check workflow or something for this?

Is there a reason you prefer lychee?

I'm more used to working with it, and it’s more convenient for checking links. If you don’t need it, I can remove it from CI.

[youyyytrok]

I couldn't find a similar alternative to the original site. Perhaps using a link from the Web Archive would work for you. If not, here are other options, though they don't provide information as concise and essential as the original site:

• XChaCha – IETF Draft
• XChaCha20-Poly1305 – Libsodium Docs

The web archive link is fine in my opinion!

I'm noticing two other links fail -- ones that go to our releases page on github. I deleted these since this crate is on crates.io. Perhaps we direct there instead?

Alright, then I'll replace the XChaCha link with the one from the web archive

Yes, I noticed that too but couldn’t find a way to fix it. When generating the changelog, the script doesn’t add a dot after "v," which makes the link invalid. But if we add the dot, the link works. For example:

• https://github.com/pluto/ronkathon/releases/tag/v0.1.0
• https://github.com/pluto/ronkathon/releases/tag/v.0.1.0

[Autoparallel]

We should just ignore having links to github based releases all together since we aren't doing them anymore. As for lychee, i don't mind keeping it in CI, but on the note of dependency minimization, if we can just use mdbook-linkcheck that seems simpler to me.

I'm happy to help here and get this across the finish line. I appreciate your work!

[youyyytrok]

Hi @Autoparallel ! Pls check my work

[Autoparallel]

@youyyytrok Nice work!

I have done the following:

• added a new workflow mdbook-test.yaml which runs the mdbook test and mdbook linkcheck.
• ran mdbook test locally after seeing this fail in CI and started fixing a few problems.

With that said, there are quite a few number of broken things in the mdbook! Now, this is not really your problem at all. I apologize for dragging this on as long as it has -- you've put in great effort and been kind even with all my shenanigans.

With that said, let me give you an option here: carry on and help fix the broken items in the mdbook, or we can merge this with a failing workflow and open an issue to fix all these problems.

Do you have a preference? In the latter case, we'd get this merged today and you are by no means being asked to continue fixing the book problems although I'd be happy to work with you to do that if you are interested!

[youyyytrok]

@Autoparallel Thank you for the feedback! Unfortunately, I can't allocate additional time to address all the issues in the mdbook. I think it would be best to merge the current changes and document the remaining problems in an issue for future work, as you suggested.

Thank you for your understanding! 🐳

[Autoparallel]

@youyyytrok no worries! I made some changes on top to address the problems.

Will merge soon.