| layout | title |
|---|---|
page |
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.
-
Note these points when adapting the documentation to a different project/product:
- 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.
💡 **Tip**
In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format).
In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format).
- If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for
*.mdfiles, as explained in [se-edu/guides] Intellij IDEA: Useful settings
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