Hyperledger Iroha 3 Documentation

This repository contains the VitePress source for the public Hyperledger Iroha documentation site, updated for the Iroha 3 / SORA Nexus track.

The implementation source of truth lives in the hyperledger-iroha/iroha i23-features branch.

The site focuses on:

• Iroha 3 quickstart and local network launch
• CLI and operator workflows
• Rust, Python, JavaScript, Android, and Swift SDK entry points
• Torii, genesis, and binary reference material

Development

Requirements:

• Node.js 18+
• pnpm 9

Install dependencies:

corepack enable
pnpm install

Run the docs locally:

pnpm dev

Build the static site:

pnpm build

Preview the built output:

pnpm serve

Quality Gates

Format:

pnpm format:fix
pnpm format:check

Lint and typecheck:

pnpm lint
pnpm typecheck

Run tests:

pnpm test

Refresh embedded snippets:

pnpm get-snippets

Optional Environment Variables

Enable the feedback modal submission target:

VITE_FEEDBACK_URL=https://example.com/get-feedback

Enable the compatibility matrix page:

VITE_COMPAT_MATRIX_URL=https://example.com/compat-matrix

The compatibility matrix uses the bundled src/public/compat-matrix.json snapshot by default. That snapshot tracks the hyperledger-iroha/iroha i23-features branch and should be refreshed when SDK coverage changes there.

Set VITE_COMPAT_MATRIX_URL only when you want to override the bundled snapshot with a live endpoint. The endpoint must return the compatibility matrix JSON expected by the docs site. The original service implementation lives in soramitsu/iroha2-docs-compat-matrix-service.

License

Iroha documentation files are available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0): http://creativecommons.org/licenses/by/4.0/