Skip to content

Conversation

@critesjosh
Copy link
Contributor

@critesjosh critesjosh commented Jan 17, 2026

Summary

Reviewed and updated the L1-L2 messaging (Portals) documentation for accuracy against the current source code implementation.

Changes to index.md (Portal overview)

  • Fixed incorrect constant MAX_MESSAGESTACK_DEPTHMAX_L2_TO_L1_MSGS_PER_TX
  • Fixed inaccurate kernel circuit description (clarified that kernel scopes messages to emitting contracts, and accumulates nullifiers rather than creating them)
  • Removed outdated "contracts tree" terminology
  • Fixed dangling "previous section" reference
  • Fixed grammar and improved clarity throughout
  • Added "See also" section with links to related pages
  • Removed non-standard importance field from front-matter

Changes to inbox.md

  • Fixed broken computeSecretHash link (was pointing to non-existent yarn-project/aztec.js/src/utils/secrets.ts, now correctly points to yarn-project/stdlib/src/hash/hash.ts)

Changes to registry.md

  • Changed hardcoded master branch links to use #include_aztec_version macro
  • Improved introductory description
  • Added documentation for missing view functions (getVersion(), getGovernance(), getRewardDistributor())
  • Added "Related pages" section

Verified as accurate (no changes needed)

  • data_structures.md - All #include_code tags verified
  • outbox.md - Edge cases and error messages verified against implementation

🤖 Generated with Claude Code

@critesjosh critesjosh changed the title fix(docs): Update l1-l2 messaging docs content fix(docs): Improve accuracy and fix broken links in L1-L2 messaging documentation Jan 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants