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.

Sign up for GitHub

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

Jump to bottom

feat: Docs: Add foundational concepts, ACIR and Sequencer pages #2716

Merged
merged 10 commits into from
Oct 10, 2023
Merged

feat: Docs: Add foundational concepts, ACIR and Sequencer pages #2716

merged 10 commits into from
Oct 10, 2023

Conversation

critesjosh
Copy link
Contributor

@critesjosh critesjosh commented Oct 5, 2023 •
edited
Loading

This PR adds several new pages to the docs:

  • It updates the Foundational Concepts main page to provide more context, adds a diagram with explanation as well as links to relevant pages
  • Adds a page on ACIR simulation to the Advanced Concepts section
  • Updates the content on the Transactions page to be more legible (although this page could still use some work)
  • Adds a page about the role of the Sequencer to the Foundational Concepts section
  • Adds a page about Fernet to the Advanced Concepts section
  • updates the dependencies in package.json in the Sandbox Getting Started page to always get the latest aztec packages (so we don't have to update this again)
  • Removes the Disclaimer from the pages that had it

Closes #2653 #2655

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

@critesjosh critesjosh requested a review from catmcgee October 5, 2023 20:07
catmcgee
catmcgee reviewed Oct 6, 2023
View reviewed changes
docs/docs/concepts/advanced/acir_simulator.md Outdated

Private functions are simulated and proved client-side, and verified client-side in the private kernel circuit.

They are run with the assistance of a DB oracle that provides any private data requested by the function.
Copy link
Contributor

Choose a reason for hiding this comment

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

would be good to have some more info about the oracle

docs/docs/concepts/advanced/acir_simulator.md

### Public Functions

Public functions are simulated and proved on the [sequencer](../foundation/nodes_clients/sequencer.md) side, and verified by the [public kernel circuit](./circuits/kernels/public_kernel.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

nice comparison

@critesjosh critesjosh requested a review from catmcgee October 7, 2023 00:09
@critesjosh critesjosh enabled auto-merge (squash) October 10, 2023 18:20
@critesjosh critesjosh merged commit 9d10326 into master Oct 10, 2023
@critesjosh critesjosh deleted the docs/jc/new-foundational-concepts branch October 10, 2023 18:23
@AztecBot AztecBot mentioned this pull request Oct 10, 2023
Merged
@critesjosh critesjosh mentioned this pull request Oct 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@catmcgee catmcgee catmcgee approved these changes

Assignees
No one assigned
Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: One pager for Foundational Concepts section w/ diagram
2 participants
@critesjosh @catmcgee