Axone technical reference

Versioned technical reference for the Axone protocol, powered with ❤️ by Docusaurus.

[![license][bsd-3-clause-image]][bsd-3-clause] [![cc-by-sa-4.0][cc-by-sa-image]][cc-by-sa]

Overview

This repository hosts . It is scoped to deep technical reference material that is versioned with, and synchronized from, Axone implementation repositories.

The Docusaurus site exposes six technical sections:

• commands, modules, and predicates, sourced from axone-protocol/axoned
• contracts, sourced from axone-protocol/contracts
• ontology, sourced from axone-protocol/ontology
• networks, generated from axone-protocol/networks

Development

Install dependencies:

yarn

Start the local development server:

yarn start

Build the static site:

yarn build

Run local checks:

yarn lint

The local search index is generated during production builds. To test search locally, run yarn build and then yarn serve.

Synchronization

External references are configured in .github/sync-external-docs-sources.json and synchronized by .github/scripts/sync-external-docs.mjs.

Dry-run synchronization:

yarn sync:external-docs:dry-run

Do not hand-edit synchronized reference content or versioned snapshots.

License

The Docusaurus site code is [3-Clause BSD][bsd-3-clause] licensed.

Documentation content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International][cc-by-sa] where applicable, unless an upstream source states otherwise.

[bsd-3-clause]: https://opensource.org/licenses/BSD-3-Clause [bsd-3-clause-image]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge [cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/ [cc-by-sa-image]: https://i.creativecommons.org/l/by-sa/4.0/88x31.png