Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

Question: should we include detailed specs in this documentation? #8

Open
icemelon opened this issue Mar 18, 2022 · 2 comments
Open

Comments

@icemelon
Copy link
Contributor

I see that the current docs only have high-level designs. But I think it'd be better to include these detailed specs of each gadget so that people can see how we prove each opcode. What do you guys think?

@ChihChengLiang
Copy link
Collaborator

Learned from @icemelon from the call that the detail of each gadget could be more than 1~2 paragraphs and more like a page of two. So it looks like good content to be in the documentation repo.

@ed255
Copy link
Member

ed255 commented Mar 18, 2022

I think having detailed specs and documentation for each gadget would be really nice! This would be very useful for someone who wants to review the implementation, or for learning tricks and ideas when writing new gadgets (by learning from existing gadgets).

I would think this suits the spec better (we could create a section under spec/ called gadgets/). But if you think that the docs is a better fit, then I'm also OK with it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants