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.

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

Merged
merged 14 commits into from
Feb 25, 2024
Merged

migrate docs website + improved docs #389

merged 14 commits into from
Feb 25, 2024

Conversation

ImmanuelSegol
Copy link
Contributor

Describe the changes

This PR...

Linked Issues

Resolves #

DmytroTym and others added 5 commits February 15, 2024 22:32
## 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
@ImmanuelSegol ImmanuelSegol marked this pull request as ready for review February 21, 2024 21:08
@DmytroTym DmytroTym mentioned this pull request Feb 22, 2024
Copy link
Contributor

@DmytroTym DmytroTym left a 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":

  1. 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.
  2. 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).
  3. 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.

docs/.codespellignore Show resolved Hide resolved
docs/docs/ZKContainers.md Outdated Show resolved Hide resolved
docs/docs/contributor-guide.md Outdated Show resolved Hide resolved
docs/docs/icicle/colab-instructions.md Outdated Show resolved Hide resolved
docs/docs/icicle/golang-bindings.md Show resolved Hide resolved
docs/docs/icicle/multi-gpu.md Outdated Show resolved Hide resolved
docs/docs/icicle/primitives/poseidon.md Outdated Show resolved Hide resolved
docs/docs/icicle/supporting-additional-curves.md Outdated Show resolved Hide resolved
docs/docs/icicle/supporting-additional-curves.md Outdated Show resolved Hide resolved
docs/docs/introduction.md Outdated Show resolved Hide resolved
@ImmanuelSegol
Copy link
Contributor Author

ImmanuelSegol commented Feb 25, 2024

I like the docs, but there are several high-level suggestions I have that can be generally described as "documenting at the right level":

  1. 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.
  2. 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).
  3. 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 like the docs, but there are several high-level suggestions I have that can be generally described as "documenting at the right level":

  1. 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.

I agree

  1. 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).

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.

  1. 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.

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>
@ImmanuelSegol ImmanuelSegol changed the base branch from main to dev February 25, 2024 15:25
@ImmanuelSegol ImmanuelSegol merged commit 7026bfb into dev Feb 25, 2024
19 checks passed
@ImmanuelSegol ImmanuelSegol deleted the migrate-docs branch February 25, 2024 21:40
ImmanuelSegol added a commit that referenced this pull request Feb 28, 2024
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>
@jeremyfelder jeremyfelder mentioned this pull request Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants