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, follow the guide [se-edu/guides] Using Jekyll 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 [se-edu/guides] Using PlantUML
Converting a document to the PDF format:
- See the guide [se-edu/guides] Saving web documents as PDF files