Documentation Guide for PlanNUS
|
Table of contents
Setting up and maintaining the project website
- We use Github Pages to manage our product documentation.
- The
docs/folder in the repository is used for documentation. - To learn how set it up and maintain the project website, follow the guide Getting started with GitHub Pages.
Style guidance
- Refer to [se-edu/guides] Markdown Coding Standard for details about the implemented documentation style.
Diagrams
- The UML diagrams were generated using draw.io (See the step-by-step guides).
Converting a web document into PDF format
- Refer to the following guide [se-edu/guides] Saving web documents as PDF files.