The documentation is built using Docusaurus 2. The deployment is done through a centralized build from IOTA WIKI. To run a local instance the IOTA WIKI CLI is used.
yarnThis command installs all necessary dependencies.
yarn startThis command starts a local, wiki themed development server and opens up a browser window. Most changes are reflected live without having to restart the server.
You can find guidance and an introduction to the needed tools and syntax on our wiki
IOTA projects usually house their Wiki documentation in the documentation folder within their repositories. This
template provides a structure to separate reader concerns, applying the Diataxis framework with
some minor modifications.
You do not have to use all of these sections, so please feel free to delete any which do not suit your needs.
The Getting Started folder should be the first section in your documentation. It should give the user a high-level overview of the project, required prior knowledge, prerequisites, and ideally a quick setup guide, or "hello world".
The How Tos folder should only address concrete examples, or how-to guides, which are goal-oriented.
The Tutorials folder should contain articles which guide the user step by step through a series of how-tos with the relevant explanations to achieve a project or real world use case. Tutorials are learning-oriented.
The Key concepts folder revolves around explanations, and are therefore understanding-oriented.
The Reference folder should describe the technical information of your project. It is information-oriented.
The Troubleshooting file should contain instructions or links to where users can post questions, or create issues if necessary.
The Contribute file should give the users directions and