-
Notifications
You must be signed in to change notification settings - Fork 3
doc: add basic mdbook #100
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
Conversation
|
Amazing to have this, it will be easier to discuss topics and design considerations on our side with this! |
sai-deng
left a comment
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.
Awesome work!
|
|
||
| Below is a representation of the interactions between the main Witness table and the different chips. | ||
|
|
||
| ```mermaid |
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.
Somehow I got:
Syntax error in text
mermaid version 11.6.0
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've tweaked it lightly, it compiles locally so not sure what's wrong, could you retry with latest version please?
book/src/construction.md
Outdated
| The Witness table is a central bus that stores values shared across operations. It gathers the pairs `(index, value)` that will be accessed by | ||
| the different chips via lookups to enforce consistency. | ||
|
|
||
| - The index column is *transparent*, or *preprocessed* [@@rap]: it is known to both prover and verifier in advance, requiring no online commitment.[^1] |
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 believe we only need one @ not two @@. Also for other citations.
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.
a single @ does not render the hyperlink when building on my side ([@@foo] is typical for the bib preprocessor AFAIK). An alternative solution (a tad prettier as it removes the brackets) is to forget about a common bibliography/references page and have everything inline as footnote references.
Fairly high level for now and incomplete, but laying foundations for extensive description of the approach later on (also easier to maintain and access than the Google docs specs).
Feel free to iterate upon