joaodecarlo85 / iota-wiki

IOTA Wiki

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.

Local Development

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. Run git submodule update --init --recursive to check out the project submodules. Optionally you can add the --remote flag to get the latest changes.

3. Install needed dependencies with yarn.

4. Start the local development server with yarn start to preview a minimal Wiki or with yarn start:all to preview the entire Wiki. Alternatively you can use the CONTENT environment variable to select the content you want to include in the preview. It accepts a list of glob patterns relative to the content subdirectory (i.e. CONTENT=identity.rs/*/documentation yarn start would give you a minimal Wiki with only identity.rs documentation included).

Contributing

The IOTA Wiki is maintained by the community. We 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.
4. Commit your changes (git commit -m 'Add some amazing feature').
5. Push your changes to your fork (git push origin feat/amazing-feature).
6. 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

Donate

The IOTA Wiki is a completely voluntary project put together, maintained, and contributed to by a group of enthusiastic community members. Feel free to support our work:

iota1qzrmyrnfhfauhv6gax50ncx844uppq4c5dddp3gk99ha0lx5jeqkwk6dapx