Documentation Guide

Setting up and maintaining the project website

• We use MarkBind to manage documentation.
• The docs/ folder contains the source files for the documentation website.
• To learn how set it up and maintain the project website, follow the guide [se-edu/guides] Working with Forked MarkBind sites for project documentation.

Style guidance:

• Follow the Google developer documentation style guide.
• Also relevant is the se-edu/guides Markdown coding standard.

Diagrams:

• See the guide se-edu/guides Using PlantUML

Converting to PDF

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