Axone documentation

Axone documentation repository, powered ❤️ by Docusaurus, a modern static website generator.

Overview

This repository contains the source code for the OKP4 documentation portal, which is hosted at https://docs.okp4.network.

Developing & contributing

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window (http://localhost:3000/). Most changes are reflected live without having to restart the server.

Note that the search won't work in development. To use the search feature, first run yarn build then yarn run serve.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Code Quality

The coding style rules are enforced by the following tools:

• Commitlint
• Markdownlint
• Prettier
• Stylelint

License

The OKP4 documentation portal is open source and 3-Clause BSD licensed.

The contents of the documentation (e.g. the .md files in the /docs folder) is Creative Commons Attribution-ShareAlike 4.0 International licensed.

You want to get involved? 😍

So you want to contribute? Great! ❤️ We appreciate any help you're willing to give. Don't hesitate to open issues and/or submit pull requests.

We believe that collaboration is key to the success of the OKP4 project. Join our Community discussions on the Community Repository to:

• Engage in conversations with peers and experts.
• Share your insights and experiences with OKP4.
• Learn from others and expand your knowledge of the protocol.

The Community Repository serves as a hub for discussions, questions, and knowledge-sharing related to OKP4. We encourage you to actively participate and contribute to the growth of our community.

Please check out OKP4 health files:

• Contributing
• Code of conduct