Skip to content

docs: add data packing and serialization guide#22448

Open
critesjosh wants to merge 3 commits intonextfrom
docs/data-packing-serialization
Open

docs: add data packing and serialization guide#22448
critesjosh wants to merge 3 commits intonextfrom
docs/data-packing-serialization

Conversation

@critesjosh
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new documentation page explaining the difference between Serialize/Deserialize and Packable traits in Aztec.nr
  • Covers when each trait is used, how to write custom Packable implementations for gas optimization, and common pitfalls
  • Includes a worked example contract (packing_example) demonstrating manual packing
  • Cross-references the new page from existing docs (custom notes, events, macros, globals) and adjusts sidebar positions

Test plan

  • Verify yarn build passes in docs/
  • Verify spellcheck passes (yarn spellcheck)
  • Confirm the new page renders correctly and sidebar ordering is correct
  • Verify packing_example contract compiles with nargo compile
  • Check all cross-references link correctly

Add new documentation page explaining the difference between
Serialize/Deserialize and Packable traits, when each is used, and how
to write custom Packable implementations for gas optimization. Includes
a worked example contract and cross-references from existing pages.
@critesjosh critesjosh added the ci-draft Run CI on draft PRs. label Apr 9, 2026
@critesjosh critesjosh marked this pull request as ready for review April 10, 2026 13:59
@critesjosh critesjosh requested a review from a team as a code owner April 10, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-draft Run CI on draft PRs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant