docs(overview): fix terminology and improve clarity for developer onboarding#20832
Open
Giri-Aayush wants to merge 1 commit into
Open
docs(overview): fix terminology and improve clarity for developer onboarding#20832Giri-Aayush wants to merge 1 commit into
Giri-Aayush wants to merge 1 commit into
Conversation
…eloper onboarding - Replace incorrect "Public VM" with "AVM" and "sequencer" to match official architecture documentation - Fix grammar: "A incoming/outgoing" to "An incoming/outgoing" - Fix grammar: "get start" to "get started", "follow" to "follows" - Fix terminology: "transactions" to "functions" for execution context - Restructure wall of text execution section into scannable bullet points - Rewrite private state section with cash analogy to help developers new to UTXO models understand notes and nullifiers - Reorder state section: public first (familiar to Solidity devs), then private with clear explanation of why nullifiers exist - Improve account abstraction wording for natural readability - Applied to both docs-developers (next) and versioned devnet docs
This file contains hidden or 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
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.
Summary
This PR improves the Aztec Overview page from the perspective of a developer who is new to Aztec. As someone onboarding into the ecosystem, I noticed several terminology inconsistencies and areas where the language could better guide newcomers through Aztec's unique concepts.
Changes
Why both
docs-developers/and versioned docs?Applied changes to both
docs-developers/overview.md(next version) anddeveloper_versioned_docs/version-v4.0.0-devnet.2-patch.0/overview.md(current stable devnet). The fixes improve clarity for current users on the stable version too. Happy to drop the versioned docs changes if the team prefers to keep those frozen.Test plan
yarn startthat both devnet and next overview pages render correctly