Documentation guide

Setting up and maintaining the project website:

• We use Jekyll to manage documentation.
• The docs/ folder is used for documentation.
• To learn how set it up and maintain the project website, we followed the guide [se-edu/guides] Using Jekyll for project documentation.
• we noted these points when adapting the documentation to our project:
  • The ‘Site-wide settings’ section of the page linked above has information on how to update site-wide elements such as the top navigation bar.
  • In addition to updating content files, we updated the config files docs\_config.yml and docs\_sass\minima\_base.scss.

Style guidance:

• Follow the Google developer documentation style guide.

• Also relevant is the [se-edu/guides] Markdown coding standard

Diagrams:

• See the [se-edu/guides] Using PlantUML

Converting a document to the PDF format:

• See the guide [se-edu/guides] Saving web documents as PDF files