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.

Sign up for GitHub

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

Jump to bottom

Create a documentation website #159

Open
2 tasks
PaulRBerg opened this issue Feb 5, 2023 · 5 comments
Open
2 tasks

Create a documentation website #159

PaulRBerg opened this issue Feb 5, 2023 · 5 comments
Labels
effort: epic Multi-stage task that may require multiple PRs. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.

Comments

@PaulRBerg
Copy link
Owner

PaulRBerg commented Feb 5, 2023 •
edited
Loading

Description

The README has become rather cluttered after implementing the casting utilities in 5085861.

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

Content

  • User-defined value types
  • Rounding mode
@PaulRBerg PaulRBerg changed the title Build a documentation website Create a documentation website Feb 5, 2023
@olivmath
Copy link

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

@PaulRBerg
Copy link
Owner Author

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?

@frontier159
Copy link

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

@PaulRBerg
Copy link
Owner Author

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

@frontier159
Copy link

Oh nice - new gh feature unlocked :-)

When will the gh dependencies track forge installs :-P

@PaulRBerg PaulRBerg added effort: epic Multi-stage task that may require multiple PRs. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: obvious work: clear Sense-categorize-respond. The relationship between cause and effect is clear. and removed documentation labels Jan 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort: epic Multi-stage task that may require multiple PRs. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@PaulRBerg @olivmath @frontier159