Documentation can be viewed on our web site at docs.iota.org

This repository contains the content which is utilised by the documentation platform in the documentation platform repository.

If you'd like to help us build missing content, please see open issues and filter by the Help Wanted label. We'll be adding more of these issues in the coming weeks as we identify more content to be added. Before writing new content, please refer to the CONTRIBUTING guide.

More information about the structure of the files and folders in this repository can be found in the STRUCTURE document.

The documentation content is created using Markdown, we also have some additional features which are documented here MARKDOWN.

If you make changes to this repository you should run the validation script before commiting any content.

To validate the content of the repo, first make sure you have installed the dependencies with npm install, then run the following script:

node buildProjects

This script will do the following:

• Print errors to the console
• Create a projects-summary.log file, which shows the structure of the content and also highlights the errors
• Create a spelling-summary.md file, which contains any possible spelling mistakes and suggestions

The spell checker uses Hunspell behind the scenes.

To enhance the spell checker, you can add words to the dictionary.json file, which supports regular expressions. For example:

{
    "global": [
        "(P|p)ermission(less|ed)"
    ],
    "smartcity": [
        "AstroPi"
    ]
}

If you want to validate just a single project you can run the script with a command line option of the specific folder name.

e.g.

node buildProjects getting-started