docs: fix quick start feedback items from review#231
Open
Keinberger wants to merge 1 commit intomainfrom
Open
Conversation
Address feedback from Dominik's Quick Start review (miden-devrel#126): - Add missing `cd my-test-project` after project creation in installation guide - Add conditional "reuse existing project" note in accounts guide - Add core transaction principle to Two-Transaction Model section - Fix "private asset transfers" wording to match public NoteType usage - Add tip blocks and section markers for duplicated code in notes guide - Add polling loop explanation comments (notes must be committed first) - Fix "Bob's account" to "Bob's client" for technical accuracy - Fix "Miden assembly" to "Miden package (.masp file)" in contract guides - Add felt! macro vs Felt type explanation - Clarify "Miden component" as "Account component" with link - Add "in the counter contract" for clarity - Add Miden Testnet Explorer link after deployment
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
1 participant
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
Addresses remaining Quick Start feedback from Dominik's review (miden-devrel#126). Brian's PRs #219-227 covered the first batch; this covers the rest.
Changes across 10 files (5 in
docs/for next version + 5 mirrored inversioned_docs/version-0.13/for current live):cd my-test-projectafter project creationmiden newfelt!explanation, clarify "Account component" with link, add "in the counter contract"Pre-existing issues noted (not fixed here)
newFaucet()inline comment in accounts.md/notes.md says "Mutable" but param isnon_fungibleyarn installstep aftercreate-miden-appin accounts.md TypeScript setupTest plan
npm run buildpasses with no new broken linksproject-templateandmiden-frontend-template@miden-sdk/miden-sdktype definitions