refactor: improve README structure and clarity#278
Open
itsyaasir wants to merge 1 commit into
Open
Conversation
chrisgitiota
reviewed
Jun 8, 2026
| - [Rust API documentation](https://iotaledger.github.io/notarization/audit_trails/index.html) | ||
| - [Move package README](./audit-trail-move/README.md) | ||
| - [Wasm package README](./bindings/wasm/audit_trail_wasm/README.md) | ||
| - [Examples](./bindings/wasm/audit_trail_wasm/examples/README.md) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Examples](./bindings/wasm/audit_trail_wasm/examples/README.md) | |
| - [Wasm Examples](./bindings/wasm/audit_trail_wasm/examples/README.md) |
chrisgitiota
reviewed
Jun 8, 2026
| - [Rust API documentation](https://iotaledger.github.io/notarization/notarization/index.html) | ||
| - [Move package README](./notarization-move/README.md) | ||
| - [Wasm package README](./bindings/wasm/notarization_wasm/README.md) | ||
| - [Examples](./bindings/wasm/notarization_wasm/examples/README.md) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Examples](./bindings/wasm/notarization_wasm/examples/README.md) | |
| - [Wasm Examples](./bindings/wasm/notarization_wasm/examples/README.md) |
chrisgitiota
reviewed
Jun 8, 2026
| - [Single Notarization examples](./bindings/wasm/notarization_wasm/examples/README.md) | ||
| - [IOTA Notarization Docs Portal](https://docs.iota.org/developer/iota-notarization) | ||
| - [Rust package README](./notarization-rs/README.md) | ||
| - [Rust API documentation](https://iotaledger.github.io/notarization/notarization/index.html) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Rust API documentation](https://iotaledger.github.io/notarization/notarization/index.html) | |
| - [Rust API documentation](https://iotaledger.github.io/notarization/notarization/index.html) | |
| - [Rust Examples](./examples/README.md) |
chrisgitiota
reviewed
Jun 8, 2026
| - [Audit Trails Wasm Package README](./bindings/wasm/audit_trail_wasm/README.md) | ||
| - [Audit Trails examples](./bindings/wasm/audit_trail_wasm/examples/README.md) | ||
| - [Rust package README](./audit-trail-rs/README.md) | ||
| - [Rust API documentation](https://iotaledger.github.io/notarization/audit_trails/index.html) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Rust API documentation](https://iotaledger.github.io/notarization/audit_trails/index.html) | |
| - [Rust API documentation](https://iotaledger.github.io/notarization/audit_trails/index.html) | |
| - [Rust Examples](./examples/audit-trail/README.md) |
chrisgitiota
reviewed
Jun 8, 2026
Comment on lines
90
to
99
| ### Shared | ||
|
|
||
| - [Repository examples](./examples/README.md) | ||
|
|
||
| ## Bindings | ||
|
|
||
| [Foreign Function Interface (FFI)](https://en.wikipedia.org/wiki/Foreign_function_interface) bindings available in this repository: | ||
|
|
||
| - [Web Assembly for Single Notarization](./bindings/wasm/notarization_wasm) | ||
| - [Web Assembly for Audit Trails](./bindings/wasm/audit_trail_wasm) |
Contributor
There was a problem hiding this comment.
IMO this content has already been documented.
chrisgitiota
reviewed
Jun 8, 2026
Comment on lines
39
to
+69
| ## Where To Start | ||
|
|
||
| ### I want a single notarized record | ||
|
|
||
| Use **Single Notarization** when your main need is proving the existence, integrity, or latest state of one notarized object on-chain. | ||
| Choose this path for one on-chain proof object, such as a document hash, immutable record, or dynamic latest-state record. | ||
|
|
||
| - [Single Notarization Rust Package](./notarization-rs) | ||
| - [Single Notarization Move Package](./notarization-move) | ||
| - [Single Notarization Wasm Package](./bindings/wasm/notarization_wasm) | ||
| - [Single Notarization examples](./bindings/wasm/notarization_wasm/examples/README.md) | ||
| - [Rust client](./notarization-rs) | ||
| - [Move contracts](./notarization-move) | ||
| - [Wasm bindings](./bindings/wasm/notarization_wasm) | ||
| - [Examples](./bindings/wasm/notarization_wasm/examples/README.md) | ||
|
|
||
| ### I want an audit trail | ||
|
|
||
| Use **Audit Trails** when you need a structured record history with permissions, capabilities, tagging, and write or delete controls. | ||
| Choose this path for structured record histories with permissions, capabilities, tagging, and write or delete controls. | ||
|
|
||
| - [Audit Trails Rust Package](./audit-trail-rs) | ||
| - [Audit Trails Move Package](./audit-trail-move) | ||
| - [Audit Trails Wasm Package](./bindings/wasm/audit_trail_wasm) | ||
| - [Audit Trails examples](./bindings/wasm/audit_trail_wasm/examples/README.md) | ||
| - [Rust client](./audit-trail-rs) | ||
| - [Move contracts](./audit-trail-move) | ||
| - [Wasm bindings](./bindings/wasm/audit_trail_wasm) | ||
| - [Examples](./bindings/wasm/audit_trail_wasm/examples/README.md) | ||
|
|
||
| ### I want the on-chain contracts | ||
|
|
||
| - [Single Notarization Move](./notarization-move) | ||
| - [Audit Trails Move](./audit-trail-move) | ||
| - [Notarization contracts](./notarization-move) | ||
| - [Audit trail contracts](./audit-trail-move) | ||
|
|
||
| ### I want to build an application | ||
|
|
||
| - [Single Notarization Rust](./notarization-rs) | ||
| - [Audit Trails Rust](./audit-trail-rs) | ||
| - [Single Notarization Wasm](./bindings/wasm/notarization_wasm) | ||
| - [Audit Trails Wasm](./bindings/wasm/audit_trail_wasm) | ||
| - [Rust client for notarized records](./notarization-rs) | ||
| - [Rust client for audit trails](./audit-trail-rs) | ||
| - [Wasm bindings for notarized records](./bindings/wasm/notarization_wasm) | ||
| - [Wasm bindings for audit trails](./bindings/wasm/audit_trail_wasm) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Wasm bindings for audit trails](./bindings/wasm/audit_trail_wasm) | |
| ### Where To Start | |
| Have a look into [Single Notarization Resources](#single-notarization) for one on-chain proof object, such as a document hash, immutable record, or dynamic latest-state record. | |
| Have a look into [Audit Trails Resources](#audit-trails) for structured record histories with permissions, capabilities, tagging, and write or delete controls. | |
| If you need to integrate the Notarization on-chain contracts into your own Move package: | |
| - [Notarization contracts](./notarization-move) | |
| - [Audit trail contracts](./audit-trail-move) | |
| If you want to build a client application: | |
| - [Rust client for notarized records](./notarization-rs) | |
| - [Rust client for audit trails](./audit-trail-rs) | |
| - [Wasm bindings for notarized records](./bindings/wasm/notarization_wasm) | |
| - [Wasm bindings for audit trails](./bindings/wasm/audit_trail_wasm) |
Contributor
|
We should add the link to the official documentation (https://docs.iota.org/developer/iota-notarization/) |
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.
Description of change
Links to any relevant issues
Type of change
How the change has been tested
Change checklist