CONTRIBUTE.md

Note This guide is meant for local development and contributing to the repository only, for guidance on the TIPs process and how to propose Tangle improvements, please see the README

Documentation

The TIPs online 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.

Prerequisites

• Node.js 16.10 or above.
• Modern Yarn enabled by running corepack enable.

Installation

yarn

This command installs all necessary dependencies.

Local Development

yarn start

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