From 8649e947075e523f29369eff15ae87385f6e476e Mon Sep 17 00:00:00 2001 From: Wern Date: Mon, 13 Nov 2023 22:29:11 +0800 Subject: [PATCH] Fix formatting --- docs/DeveloperGuide.md | 4 +++- docs/UserGuide.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 412cfe48dd0..4502707acb7 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -19,6 +19,7 @@ title: Developer Guide -------------------------------------------------------------------------------------------------------------------- ## **Setting up, getting started** +{: .reset-page-break-defaults} Refer to the guide [_Setting up and getting started_](SettingUp.md). @@ -26,9 +27,10 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md). ## **Design** -
+
:bulb: **Tip:** The `.puml` files used to create diagrams in this document `docs/diagrams` folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html) to learn how to create and edit diagrams. +
### Architecture diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 98a543d933e..c03d2af2f17 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -74,7 +74,7 @@ title: User Guide ### Small information pills -| Component | Description | +| Component | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | :trophy: Learning outcomes | The learning outcome of the section. | | Beginner
Intermediate
Expert | The difficulty level of the section, with Beginner for new users, Intermediate for users who have completed the tutorial, and Expert for users who have completed and used the features in the User Guide. |