Rustdoc documentation

[igaray]

• The rustdoc comments should be polished and expanded in general.
• cleopatra is yet green to publish to crate.io and thus docs.rs but perhaps work could be done on the CI to add the rendered docs to the repo's github pages.

[PartyLich]

... work could be done on the CI to add the rendered docs to the repo's github pages.

Are you accepting PRs for this?

If so, there's a working example in my fork. The bench page remains the root, and has an additional link to the docs.

[igaray]

We most definitely are accepting PRs! I took at the changes in your fork, they look good

[PartyLich]

Cool. PRs opened. One targeting main (the CI workflow and makefile), one targeting gh-pages (the template update).

Let me know if it needs any adjustment, I'll update as soon as time allows.

[pefontana]

Already done