Axone technical reference

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

Overview

This repository hosts https://docs.axone.xyz. It is scoped to deep technical reference material that is versioned with, and synchronized from, Axone implementation repositories.

The Docusaurus site exposes five technical sections:

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

Editorial, onboarding, tutorial, FAQ, and whitepaper content are intentionally out of scope for this repository.

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 licensed.

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