Updating the Documentation for QAP

To update the documentation, you will need Jekyll (to preview the html generated from markdown before committing). Install it using the instructions here. Then:

1. Clone the curent development branch of the repo.

• git clone -b <dev branch> https://github.com/preprocessed-connectomes-project/quality-assessment-protocol.git

2. cd into docs.
3. Create and edit markdown files for the documentation that you wish to update/add. These will be embedded within the layout stored in _layout/page.html. You can preview all HTML pages by typing the following command in a terminal whose working directory is the repo, and then navigating to http://127.0.0.1:4000/. The pages will be updated every time you modify their corresponding markdown files.

• jekyll serve --watch

4. When you are done and the pages appear as they should in the preview, commit and push.