-
Notifications
You must be signed in to change notification settings - Fork 98
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
migrate docs website + improved docs #389
Conversation
## Contents of this release [FEAT]: support for multi-device execution: #356 [FEAT]: full support for new mixed-radix NTT: #367, #368 and #371 [FEAT]: examples for Poseidon hash and tree builder based on it (currently only on C++ side): #375 [PERF]: MSM performance upgrades & zero point handling: #372
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the docs, but there are several high-level suggestions I have that can be generally described as "documenting at the right level":
- I know that the plan is to integrate doc comments from the code into this documentation. I think this is a great idea and imo it should replace all the code snippets and descriptions of specific types and functions that are currently present in the docs. Comments in the code are much more easily maintainable and updatable.
- Tbh I don't like the technical descriptions of primitives. I think explaining how exactly rounds of Poseidon work with pictures is an overkill. Imo linking a good resource is enough. The same goes for NTT and MSM to less extent as there are fewer details about them in respective readmes which is a good thing (imo).
- There are some instructions which I would consider common knowledge like testing Rust with
cargo test
or how to add a dependency in Cargo. Though that might be just me.
I agree
I did this to make it accessible to everyone. Personally myself I only need the how to compile docs and i would just read the code an examples. But I know the majority of people may not know what MSM is exactly.
Same, its to make it accessible, I wanted everyone to be able to enjoy the docs. I dont want to start assuming everything that I know is obvious to everyone else. Yes I agree cargo test is very very common knowlage, but what if im a golang developer who wants to check out the rust bindings ? i want to save him the time. |
Co-authored-by: Jeremy Felder <jeremy.felder1@gmail.com>
migrate docs website + improved docs (#389) * Update README.md (#385) * refactor * refactor * refactor * rename task * update codespell * multi gpu docs (#391) * Refactor * refacotr * fix typo * Apply suggestions from code review * refactor * refactor --------- Co-authored-by: ImmanuelSegol <3ditds@gmail.com> Co-authored-by: DmytroTym <dmytrotym1@gmail.com> Co-authored-by: ChickenLover <Romangg81@gmail.com>
Describe the changes
This PR...
Linked Issues
Resolves #