#Calo Documentation Guide

Documentation

• Each of the documentation page is written in .md file, whcih makes use of Jekyll.
• Reason for Choosing: We choose to use it because it is simple to learn and deploy (so we can focus on the code and its quality) and yet is friendly to browse on websites.
• File Location: All the documenation-related files (inclding images, .md file) is within roots/docs/.
• To learn how set it up and maintain the project website, follow the guide [se-edu/guides] Using Jekyll for project documentation.

Style guidance:

• The code used in development of Calo follows Google developer documentation style guide.

Learning Resources

• Markdown which is used to style .md file: [se-edu/guides] Markdown coding standard
• Diagram: [se-edu/guides] Using PlantUML
• Convert .md to .pdf: [se-edu/guides] Saving web documents as PDF files