prb-math icon indicating copy to clipboard operation
prb-math copied to clipboard

Published 20 hours ago • verified publisher icon PaulRBerg

Create a documentation website

Open PaulRBerg opened this issue 2 years ago • 5 comments

Description

The README has become rather cluttered after implementing the casting utilities in https://github.com/PaulRBerg/prb-math/commit/5085861101e592cde0ce6239031bb679cde7a2dc.

I should move the documentation to a dedicated documentation website built with Docusaurus, ReadTheDocs, or MDBook.

Content

  • [ ] User-defined value types
  • [ ] Rounding mode

PaulRBerg avatar Feb 05 '23 17:02 PaulRBerg

I am willing to help, I have experience with docusaurs, this was my last project: https://github.com/lunes-platform/telescope

olivmath avatar Feb 23 '23 01:02 olivmath

Awesome, glad to hear that, Lucas!

PRs welcome 🥰

Would it be possible to keep the Docusaurus website in a directory in this repo, e.g. docs?

PaulRBerg avatar Feb 23 '23 10:02 PaulRBerg

Thanks for the lib - this is awesome. Would be great if these docs could list known uses too.

It's noted that this hasn't been audited, but perhaps it has via other protocols using the libs

frontier159 avatar Feb 23 '23 23:02 frontier159

Thanks, @frontier159. I agree that a list of known users would be helpful, and of course I agree that PRBMath has sort of already been audited by the community.

You can see a preliminary report of users in the "Dependency graph" section on GitHub:

https://github.com/PaulRBerg/prb-math/network/dependents

PaulRBerg avatar Feb 24 '23 06:02 PaulRBerg

Oh nice - new gh feature unlocked :-)

When will the gh dependencies track forge installs :-P

frontier159 avatar Feb 24 '23 06:02 frontier159