Conversation
CLAUDE.md provides guidance for Claude Code with build commands, architecture overview, and conventions. ONBOARDING.md is a progressive tutorial that takes Ethereum developers from reading code to deploying on devnet. README.md updated with a link to the onboarding guide. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Expand the "Key insight" section in ONBOARDING.md to explain that the real advantage isn't just easier commit-reveal, but composability in private execution — private functions validating constraints over hidden inputs, storing encrypted state, and interacting with public state atomically. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…-clear-onboarding-document-for-aztec-starter
Resolve merge conflicts in README.md and config/local-network.json, update stale version references in CLAUDE.md and ONBOARDING.md to match the new pinned version. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ING.md Explain that "private → public" means a private function enqueuing a public function within the same transaction, not a third function type. Also adds inline code comments, a Context explainer, a composability diagram, and various other improvements to the onboarding tutorial. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sklppy88
approved these changes
Mar 3, 2026
Contributor
sklppy88
left a comment
sklppy88
left a comment
There was a problem hiding this comment.
Still thinking about this but it would be ideal to have everything in include codes, even bash for the running, so we know the entire setup process also works and is updated / current. That I think requires a bit more thought re standards / sops for any code-along tutorials
Resolve CLAUDE.md conflict by taking the more comprehensive version from next and appending the ONBOARDING.md maintenance section from this branch. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ng examples in contract functions
ONBOARDING.md code snippets were manually copied from source files with hardcoded line numbers that went stale on every contract change. This adds the include_code remark plugin to extract snippets from source at build time. - Add docs:start/docs:end markers to 7 source files (19 marker pairs) - Create docs/ONBOARDING.src.md with #include_code directives - Install include_code, remark, remark-cli; add .remarkrc.mjs config - Add yarn docs:build script to regenerate ONBOARDING.md - Update CLAUDE.md with new docs workflow instructions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Author
|
@sklppy88 i updated it to use include_code macros |
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
2 participants
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
Test plan
ONBOARDING.mdcode snippets match current contract sourceCLAUDE.mdwork on a fresh clone🤖 Generated with Claude Code