dogdev/documentation-platform

Repository for the web application deployed as https://docs.iota.org - For the content repository, see https://github.com/iotaledger/documentation

IOTA Documentation

This repository contains the web application which displays the documentation, the actual content is housed in its own repository https://github.com/iotaledger/documentation.git

Supporting The Project

If you would like to contribute to the web application, consider posting a bug report, feature request or a pull request.

For information and issues related to the documentation content please visit the documentation-markdown repository.

Development

The documentation application is created as a React Static application. If you wish to do any development work on the app you should perform the following steps.

git clone https://github.com/iotaledger/documentation-platform.git
npm install

You will then need to add the content from the https://github.com/iotaledger/documentation.git repository to the /docs folder.

Once you have the content in the /docs folder you need to index all the documents, you can do this by running:

npm run build-index

Only once the steps above are completed can you build and run the app:

npm run start

There is also an associated API for the application for more details on that see ./api/README.md

Deployment

See ./DEPLOYMENT.md for deployment instructions.