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

ELI15: Gadgets Blank in User Documentation #824

Open
gumdropsteve opened this issue Jul 12, 2024 · 0 comments
Open

ELI15: Gadgets Blank in User Documentation #824

gumdropsteve opened this issue Jul 12, 2024 · 0 comments

Comments

@gumdropsteve
Copy link

gumdropsteve commented Jul 12, 2024

Which section of the Halo 2 book were you reading?

I was reading gadgets.md from the /user section which can be found halo2/blob/main/book/src/user/gadgets.md or online.

What was unclear?

There is no content in the # Gadgets section, none was ever pushed.

zcash/halo2/blob/main/book/src/user/gadgets.md is blank and displays blank online as expected.

What would help to make it clearer to you?

Given the file has not been edited in 4 years, I am interested to know if this was/is a planned/active module that was never documented or an error that has not been cleaned.

The file should either be removed or updated.

Naming could also be made consistent. This is in the User-Documentation section in the hosted docs and in the /user/ section in the code.

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

No branches or pull requests

1 participant