README.md

AIS dom Documentation

This is the source for the AIS dom documentation.

Updating the docs

Documentation is build using Docusaurus.

Preparing environment

Running the documentation locally requires NodeJS and Yarn to be installed. Inside a cloned fork of this repository, run:

$ script/setup

This will install docusaurus amongst other things.

Running docs locally

$ script/server

It will start a server at localhost:3000.

Adding a page

• Create new page in docs/
• Add new doc to website/sidebars.json

You will need to restart the server when creating a new file or make changes to sidebars.json. If you're updating a document, you will only need to refresh your browser to get the latest changes.

Adding a version

$ cd website
$ yarn run version 1.0.0

Publish the page

$ cd website
$ yarn run build
$ GIT_USER=<user>   CURRENT_BRANCH=master   USE_SSH=false   yarn run publish-gh-pages