Writing a documentation

Below is the step-by-step instructions on how to modify, test and deploy the Tristan v2 documentation.

1. Install Hugo.

2. Clone the wiki branch:

   git clone -b wiki git@github.com:PrincetonUniversity/tristan-v2.git tristan-v2-wiki
   cd tristan-v2-wiki
   

3. Download all the dependency modules locally:

   hugo mod tidy
   

4. Run the website on localhost in debug mode:

   hugo server -D
   

5. Modify any of the .md files in the content/ directory and view the changes live in http://localhost:PORT/tristan-v2 (Hugo will print which port it’s using when you launch hugo server -D).

6. When finished, make sure everything looks as expected, and simply add/commit and push your changes. GitHub actions workflow will automatically deploy the website.

   git add .
   git commit -m 'COMMENT'
   git push