Versioned technical reference for the Axone protocol, powered with ❤️ by Docusaurus.
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 six technical sections:
commands,modules, andpredicates, sourced fromaxone-protocol/axonedcontracts, sourced fromaxone-protocol/contractsontology, sourced fromaxone-protocol/ontologynetworks, generated fromaxone-protocol/networks
Editorial, onboarding, tutorial, FAQ, and whitepaper content are intentionally out of scope for this repository.
Install dependencies:
yarnStart the local development server:
yarn startBuild the static site:
yarn buildRun local checks:
yarn lintThe local search index is generated during production builds. To test search locally, run yarn build and then yarn serve.
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-runDo not hand-edit synchronized reference content or versioned snapshots.
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.