Aligned Move, Rust and TypeScript documentation for Audit Trail and Notarization#257
Open
chrisgitiota wants to merge 26 commits into
Open
Aligned Move, Rust and TypeScript documentation for Audit Trail and Notarization#257chrisgitiota wants to merge 26 commits into
chrisgitiota wants to merge 26 commits into
Conversation
Maps each public Move function or struct in the `audit-trail-move/sources/` modules to the related Rust entities in `audit-trail-rs/src/` and WASM/TS entities in `bindings/wasm/audit_trail_wasm/src/`.
…ill files facilitating documentation sync-up
…according to the guide
…ed-docs # Conflicts: # audit-trail-move/sources/audit_trail.move # audit-trail-rs/src/core/access/transactions.rs # audit-trail-rs/src/core/records/transactions.rs
… TS docs according to the guide
… and reference it from audit_trail_wasm CLAUDE.md
…ings/wasm root README
…on and reference it from new CLAUDE.md for audit-trail-move and notarization-move
…ls into product agnostic skills and introduce new skill init-api-mapping
…d extended Rust docs
…ed-docs # Conflicts: # audit-trail-move/Move.lock
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
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.
Summary
Aligns the documentation across the three implementation layers — Move smart contracts, Rust client crates, and WASM/TypeScript bindings — for both Audit Trail and Notarization.
The goals are
No behavioural changes — documentation, style guides, and tooling only.
See DOC-SKILL-EXAMPLES for examples and explanations how to use the SKILL based doc alignment process.
What's in the PR
Style guides (new, top-level)
MOVE-DOC-STYLEGUIDE.md— authoritative rules for Move doc comments (audience, block ordering, capability gating, abort/event conventions).bindings/wasm/DOC-STYLEGUIDE.md— equivalent rules for wasm-bindgen-generated TSDoc/JSDoc (TS-visible names,{@link}syntax, allowed tags, etc.).Per-product
CLAUDE.mdguidesaudit-trail-move/CLAUDE.md,notarization-move/CLAUDE.md— reference the Move styleguide and pin product-specific terminology (e.g. the "Notarization Methods" rules).bindings/wasm/audit_trail_wasm/CLAUDE.md,bindings/wasm/notarization_wasm/CLAUDE.md— same for the TS side.API mapping files (new)
audit-trail-move/api_mapping.toml,notarization-move/api_mapping.toml— map every public Move function/struct/enum to its Rust and WASM/TS counterparts. Used as index when syncing docs across layers to reduce token consumption resp. compare docs of the specific languages more efficiently.Product-agnostic skills (new, under
.claude/skills/)init-api-mapping— bootstraps anapi_mapping.tomlfor a new product.update-api-mapping— reconciles the mapping against a git revision (added/removed entities).sync-product-docs— syncs Move/Rust/WASM doc comments using the mapping.Doc comment rewrites
audit-trail-move/sources/*.move,notarization-move/sources/*.move— full rewrite under the new style guide, including consistent abort and event sections.audit-trail-rs/src/**,notarization-rs/src/**— Rust docs updated to mirror the Move semantics (per-method bullet lists where behaviour differs, accurate lock semantics,TimeLock::Infinitedestruction rule, etc.).bindings/wasm/audit_trail_wasm/src/**,bindings/wasm/notarization_wasm/src/**— TSDoc rewritten to TS-visible names with{@link}references, matching the Move/Rust semantics from the mapping.Notable conventions established
Dynamic/Lockedare always referred to as Notarization Methods (never "variant", "kind", "mode", etc.); per-method behaviour is documented as a fixed-order bullet list so future methods can be added without restructuring prose.Requires the {@link Permission.X}block.Fooevent on success.").Test plan
cargo build --workspace --tests --examplescargo clippy --all-targets --all-featurescargo doc --workspace --no-depsproduces no rustdoc warningscd bindings/wasm/notarization_wasm && cargo check --target wasm32-unknown-unknowncd bindings/wasm/audit_trail_wasm && cargo check --target wasm32-unknown-unknownnpm run buildin both WASM crates; skim generated.d.tsfor broken{@link}references or stray rustdoc artifacts# Errors/# Examplesrustdoc headings leaked into Move sources)