Contributing

Run the Rust and documentation validation gates before publishing changes.

cargo fmt --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace --all-features
cargo deny check
cargo audit
npm run docs:build

Public contracts live near their owning crates and are represented by committed schema files under crates/*/schemas.

Generate schema files from the Rust contract types after public contract changes:

cargo run -p ironloom-schemas

Verify committed schema files have no drift:

cargo run -p ironloom-schemas -- --check

Documentation Development

Run the VitePress development server with:

npm run docs:dev

Build the static site with:

npm run docs:build

When functionality changes affect a documented surface, update the English source docs and every localized docs tree in the same change.

Contributors

Vanna DiCatania

Changelog

Last edited 3 days ago

View full history

45d8a69-docs: localize VitePress site and add diagrams

8bce194-feat(docs): migrate site to vitepress

8a501d8-feat: migrate Ironloom platform to Rust