Skip to content

docs: add Proof of Inclusion documentation - #331

Merged
itsyaasir merged 3 commits into
feat/poi-implementationfrom
chore/update-readme
Aug 25, 2026
Merged

docs: add Proof of Inclusion documentation#331
itsyaasir merged 3 commits into
feat/poi-implementationfrom
chore/update-readme

Conversation

@itsyaasir

Copy link
Copy Markdown
Contributor

Description of change

Adds Proof of Inclusion as the third Notarization Toolkit component in the repository documentation and aligns its Rust, Wasm, and example READMEs with the existing component structure.

The updated documentation:

  • explains when to use Proof of Inclusion and how it differs from the on-chain components;
  • documents proof construction, verification, trust boundaries, and the proof model;
  • adds Mermaid sequence diagrams for construction and verification;
  • aligns Package terminology across the root, Rust, and Wasm documentation;
  • documents how to build and install the poi CLI from source, since pre-built binaries are not distributed; and
  • updates Rust and Wasm example prerequisites, learning objectives, and resource links.

Links to any relevant issues

None.

Type of change

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change or feature that changes existing behavior
  • Documentation Fix

How the change has been tested

  • cargo test -p poi-rs --doc
  • cargo check -p poi-rs
  • cargo check -p poi-rs --features cli
  • cargo build --release -p poi-rs --features cli --bin poi
  • ./target/release/poi --version
  • git diff --check
  • Verified relative Markdown links and reviewed the PoI documentation with the repository naming-conventions skill.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own changes
  • I have made corresponding changes to the documentation
  • I have checked that the relevant documentation and build checks pass locally

@itsyaasir
itsyaasir merged commit 3a69eb0 into feat/poi-implementation Aug 25, 2026
10 checks passed
@itsyaasir
itsyaasir deleted the chore/update-readme branch August 25, 2026 16:37
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.

1 participant