Skip to content

Documentation Baseline for Integrators: Module Narratives, ABI Surface, Storage Layout, and Contributor Rules#379

Open
zakkiyyat wants to merge 5 commits into
Lead-Studios:mainfrom
zakkiyyat:codex/zakkiyyat-contract-docs-foundation
Open

Documentation Baseline for Integrators: Module Narratives, ABI Surface, Storage Layout, and Contributor Rules#379
zakkiyyat wants to merge 5 commits into
Lead-Studios:mainfrom
zakkiyyat:codex/zakkiyyat-contract-docs-foundation

Conversation

@zakkiyyat
Copy link
Copy Markdown

Summary

Minimal documentation-focused implementation for assigned issues.

Included

  • Added module-level //! documentation to key contract modules:
    • admin.rs, balance.rs, escrow.rs, dispute.rs, splitter.rs, recurring.rs, storage_types.rs, validation.rs
  • Added docs/abi-reference.md with callable contract surface grouped by domain.
  • Added docs/storage-layout.md documenting all DataKey variants, storage class, value types, ownership, and TTL behavior.
  • Updated CONTRIBUTING.md with contract conventions, module wiring workflow, and explicit PR checklist items.

Closes #222
Closes #223
Closes #224
Closes #225

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 30, 2026

@zakkiyyat Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment