EXPLORE THE WIKI

Report Error · Request Topic

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Local Development
• Contributing
• Contact

About the Project

The IOTA Wiki is a central hub for entering into the IOTA ecosystem. A community driven initiative to provide an up-to-date collection of introductions and further reading about the technology, the teams, the community, and everything in between. So anyone can learn how to build, adopt, and engage with IOTA, all in one space.

Built With

The IOTA Wiki is built using TypeScript, ReactJS and Docusaurus v2.0.

Getting Started

Prerequisites

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

Preview Locally

Because the Wiki is a large project composed of several Docusaurus builds and external documentation, a full build takes a while. To speed up development, we provide environment variables to select different configurations, and some convenience scripts with environment variables pre-configured.

To preview the Wiki locally, use the following steps. For more preview and build configurations, see Pre-configured scripts and Environment variables for reference.

1. Clone the repository by running git clone https://github.com/iota-wiki/iota-wiki.git and go to the directory with cd iota-wiki.
2. Install dependencies with yarn.
3. Build plugins once with yarn build:plugins
4. Preview a specific environment with yarn start:<environment> where environment can be iota, shimmer or next.

You should always prefer previewing only a specific environment of the Wiki, but if you need a complete Wiki build you can replace step 3 with yarn start:all. Keep in mind this will take a while and has no hot reloading capability.

Pre-configured scripts

Script	Explanation
start:<environment>	Start a development server for the iota, shimmer, or next environment, with hot reloading on changes.
start:all	Build all environments and serve the result, without hot reloading on changes.
build:<environment>	Build the iota, shimmer, or next environment.
build:all	Build all environments.
checkout:remote:<environment>	Check out the latest version of external documentation for the iota, shimmer, or next environment.
checkout:remote	Check out the latest version of external documentation.
generate:api	Generate available API documentation configured through the Docusaurus OpenAPI plugin.

Environment variables

Variable	Accepts	Default	Explanation
ENVIRONMENT	One of iota, shimmer, or next	iota	The environment to build.
MODE	One of development, or production	development	Depending on the mode chosen, some functionalities are included or excluded (analytics for example).
EXTERNAL	A comma separated list of glob patterns		What external documentation to include in the build. Glob patterns are relative to the <environment>/external directories.

For example ENVIRONMENT=iota EXTERNAL=tips/** yarn start starts a development server for the iota environment with the TIPs included

Contributing

The IOTA Wiki is maintained by the IF and community contributions are always welcome. The DX team and related teams from the IF will review all issues and pull requests posted to this repository. If you notice any mistakes, or feel something is missing, feel free to create an issue to discuss with the team or directly create a pull request with suggestions. Here is a basic workflow to open a pull request:

1. Fork this repository to your own account and clone it (git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git)
2. Create a feature branch for your changes (git checkout -b feat/amazing-feature).
3. Make your changes and optionally preview them locally.
4. Run yarn lint and yarn format and fix any remaining errors and warnings.
5. Commit your changes (git commit -m 'Add some amazing feature').
6. Push your changes to your fork (git push origin feat/amazing-feature).
7. Open a pull request to the main branch of this repository.

Have a look at CONTRIBUTING for further guidance.

Online one-click setup for contributing

You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click it will prepare everything you need to build and contribute to the Wiki. Just click on this button and skip step 1 from above.

Contact

Phylo - Phyloiota - Phylo [Community DAO - lets go!]#2233
Jeroen van den Hout - jlvandenhout - jvdhout#4402
Dr.Electron - Dr-Electron - Dr.Electron#9370
Critical - Critical94 - Critical#7111
JSto - JSto91 - JSto#3746