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

Docs: One pager for Foundational Concepts section w/ diagram #2653

Closed
Tracked by #2658
critesjosh opened this issue Oct 3, 2023 · 1 comment · Fixed by #2716
Closed
Tracked by #2658

Docs: One pager for Foundational Concepts section w/ diagram #2653

critesjosh opened this issue Oct 3, 2023 · 1 comment · Fixed by #2716
Assignees
@critesjosh
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback

Comments

@critesjosh
Copy link
Contributor

Create a one pager for https://docs.aztec.network/concepts/foundation/main that provides more context about the contents of the section. Include an architecture diagram that helps people map out the included concepts.

Include a diagram and pages (can be links) about the network architecture (sequencer, prover, PXE, rollup/Ethereum).
@critesjosh critesjosh added A-documentation Area: relates to documentation T-feedback Type: recording user feedback labels Oct 3, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Oct 3, 2023
@critesjosh critesjosh mentioned this issue Oct 3, 2023
Closed
@critesjosh
Copy link
Contributor Author

A simpler version of this diagram would be good

@critesjosh critesjosh self-assigned this Oct 5, 2023
@critesjosh critesjosh mentioned this issue Oct 5, 2023
Merged
4 tasks
critesjosh added a commit that referenced this issue Oct 10, 2023
@critesjosh
feat: Docs: Add foundational concepts, ACIR and Sequencer pages (#2716)
9d10326 
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.
- [x] I have reviewed my diff in github, line by line and removed
unexpected formatting changes, testing logs, or commented-out code.
- [x] Every change is related to the PR description.
- [x] I have
[linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
this pull request to relevant issues (if any exist).
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@critesjosh critesjosh

Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Docs: Add foundational concepts, ACIR and Sequencer pages AztecProtocol/aztec-packages
2 participants
@critesjosh @catmcgee