Improving Multisig Tutorial for Clarity & Usability #835
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
tippi-fifestarr
requested review from
gregnazario and
hariria
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@hariria was thinking of adding this diagram (.SVG) in there at the top of the tutorial, what do you think? |
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
Overhauled Your First Multisig tutorial by making it more structured, beginner-friendly, and engaging.
Key Improvements:
✅ Step-by-step structure: Added the
Stepscomponent.✅ Bank vault analogy: Introduced an intuitive real-world comparison to explain multisig accounts.
✅ Reduced complexity: Simplified explanations, removed unnecessary details throughout, distracting links from the intro, and focused on essential concepts.
✅ Improved onboarding: Included explicit setup instructions (virtual environment, Python installation check, etc.).
✅ More explanations: Clarified how multisig in Aptos differs from Ethereum (protocol-level vs. smart contract) and after each code block.
✅ Better external linking: Linked out to relevant resources at the end for further exploration.
These changes aim to make the tutorial more accessible to developers, especially those new to Aptos. 🚀
Note: We are currently conducting user interviews and may continue updating this over the coming weeks and months.
Checklist
pnpm fmt?pnpm lint?