Skip to content

Organize docs: front and back end; custom predicates.#96

Merged
ax0 merged 3 commits intomainfrom
aardocs10
Mar 2, 2025
Merged

Organize docs: front and back end; custom predicates.#96
ax0 merged 3 commits intomainfrom
aardocs10

Conversation

@tideofwords
Copy link
Collaborator

Made some improvements to the docs.

Mostly just reorganizing existing content, but added some new material on front and back ends.

Copy link
Collaborator

@arnaucube arnaucube left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
just left a couple of small comments

Comment on lines +49 to +52
## `Raw`
"Raw" is short for "raw value". A `Raw` exposes a backend value on the frontend.

With the plonky2 backend, a `Raw` is a tuple of 4 elements of the Goldilocks field.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the Raw in this section equivalent to the Value type at the section backendtypes.md?


## Compound types

The three front-end compound types (`Dictionary`, `Array`, `Set`) are all represented as Merkle roots on the backend. The details of the representation are explained on a separate [Merkle tree](./merkletree.md) page. No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to define (not necessarily now in this PR) where the Dictionary,Array,Set belong: here they appear in the Backend section referencing the merkletree.md file, on the same time they are described at the Frontend subsection values.md file; and in the code they are implemented in the middleware.

Copy link
Collaborator

@ax0 ax0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ax0 ax0 merged commit c9f7427 into main Mar 2, 2025
4 checks passed
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.

3 participants