-
Notifications
You must be signed in to change notification settings - Fork 311
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
chore: docs in the monorepo #1128
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Known issue: Deposited funds not showing
Smart contract address list docs update
Covering: - Link to ETHGlobal workshop video - Latest example updates from Maxim - Minor edits
Update Noir Guide
Rearrange content and revise wordings for better logic flow
With minor edits
…references rm a3 references
…-acir-refs replace acir++ w. acir
Update l1-l2-messaging.md
…abstractions-extension Clarify on communication abstractions
Fix typo in indexed-merkle-tree.mdx
* feat(batch-insertion): init commit * fix: cpp -> auto * fix: update image links * fix: various minor formatting * fix: latex fixes * fix: some review edits * fix: latex tests * fix: latex exp exp exp exp * fix: 20 formatting? * fix: update legend * fix: diagram colours
Fix link in overview
Add sequencers/provers updates, link to barretenberg's source code, and update the smart contracts description
Update glossary.md
Update overview.mdx
Implements #1085. Aims to make docs more accessible during engineer feature development.
34361a2
to
d582d80
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #1085. Documentation should be owned more by engineers, right now
it's hard to iterate the examples easily. As well we want to avoid code-rot
by automatically updating examples.
History has been rewritten to maintain valid issue and PR links.
Redoing #1120
EDIT FOR POSTERITY: Process was similar to the below (although this exact script was for barretenberg):
Checklist: