The reference.html page is built using the
openapi.yaml file. Changes to content on this page
should be made by opening a pull request against the
Content Store application.
Other HTML pages are in the /source directory of this repository
and are authored using Markdown. You can suggest edits to these pages by making
changes in a branch or fork of this project and then opening a pull request.
Running documentation locally
To run the documentation locally you should have this repository checked out
as well as the Content Store.
Installing dependencies
Setting up the documentation requires Ruby. Run the following to install the
necessary dependencies:
make requirements
Preview changes
Whilst writing documentation we can run a middleman server to preview how the
published version will look in the browser. After saving a change the preview in
the browser will automatically refresh on HTML pages. However for changes to
openapi.yaml you will need to restart the preview.
The preview is only available on our own computer. Others won’t be able to
access it if they are given the link.