Skip to content

Commit 0102e69

Browse files
tituschewxjtituschewxj
committed
Update DG and UG content page
1 parent ed7017b commit 0102e69

File tree

4 files changed

+84
-6
lines changed

4 files changed

+84
-6
lines changed

‎docs/DGContentPage.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## **Table of Contents**
2+
3+
* [**Acknowledgements**](DeveloperGuide.md#acknowledgements)
4+
* [**Setting up, getting started**](DeveloperGuide.md#setting-up-getting-started)
5+
* [**Design**](DeveloperGuide.md#design)
6+
* [Architecture](DeveloperGuide.md#architecture)
7+
* [UI component](DeveloperGuide.md#ui-component)
8+
* [Logic component](DeveloperGuide.md#logic-component)
9+
* [Model component](DeveloperGuide.md#model-component)
10+
* [Storage component](DeveloperGuide.md#storage-component)
11+
* [Common classes](DeveloperGuide.md#common-classes)
12+
* [**Implementation**](DeveloperGuide.md#implementation)
13+
* [Autocomplete Feature](DeveloperGuide.md#autocomplete-feature)
14+
* [Command History Retrieval](DeveloperGuide.md#command-history-retrieval)
15+
* [[Proposed] Undo/Redo Feature](DeveloperGuide.md#proposed-undo-redo-feature)
16+
* [**Documentation, logging, testing, configuration, dev-ops**](DeveloperGuide.md#documentation-logging-testing-configuration-dev-ops)
17+
* [**Appendix: Requirements**](DeveloperGuide.md#appendix-requirements)
18+
* [Product scope](DeveloperGuide.md#product-scope)
19+
* [User stories](DeveloperGuide.md#user-stories)
20+
* [Use cases](DeveloperGuide.md#use-cases)
21+
* [Non-Functional Requirements](DeveloperGuide.md#non-functional-requirements)
22+
* [Glossary](DeveloperGuide.md#glossary)
23+
* [**Appendix: Instructions for manual testing**](DeveloperGuide.md#appendix-instructions-for-manual-testing)
24+
* [Launch and shutdown](DeveloperGuide.md#launch-and-shutdown)
25+
* [Adding a student](DeveloperGuide.md#adding-a-student)
26+
* [Editing a student](DeveloperGuide.md#editing-a-student)
27+
* [Deleting a student](DeveloperGuide.md#deleting-a-student)
28+
* [Finding a student](DeveloperGuide.md#finding-a-student)
29+
* [Marking a student's attendance](DeveloperGuide.md#marking-a-student-s-attendance)
30+
* [Unmarking a student's attendance](DeveloperGuide.md#unmarking-a-student-s-attendance)
31+
* [Setting the course name](DeveloperGuide.md#setting-the-course-name)
32+
* [Autocompleting fields](DeveloperGuide.md#autocompleting-fields)
33+
* [Retrieving previous successful commands](DeveloperGuide.md#retrieving-previous-successful-commands)
34+
* [Accessing help](DeveloperGuide.md#accessing-help)
35+
* [Clearing all data](DeveloperGuide.md#clearing-all-data)
36+
* [**Appendix: Design Decisions**](DeveloperGuide.md#appendix-design-decisions)
37+
* [**Appendix: Effort**](DeveloperGuide.md#appendix-effort)
38+
* [**Appendix: Planned Enhancements**](DeveloperGuide.md#appendix-planned-enhancements)

‎docs/DeveloperGuide.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88
# TAPro Developer Guide
99

1010
<!-- * Table of Contents -->
11-
<page-nav-print>Table of Contents</page-nav-print>
11+
<div class="d-none d-print-block">
12+
<br>
13+
<include src="DGContentPage.md" />
14+
</div>
1215

1316
{{ newPage }}
1417

@@ -81,7 +84,7 @@ The bulk of TAPro's work is done by the following four components:
8184
The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user
8285
issues the command `delstu nn/E1234567`.
8386

84-
<puml src="diagrams/ArchitectureSequenceDiagram.puml" width="574" />
87+
<puml src="diagrams/ArchitectureSequenceDiagram.puml" width="680" />
8588

8689
Each of the four main components (also shown in the diagram above),
8790

@@ -96,7 +99,7 @@ The `Logic` component defines its API in the `Logic.java` interface and implemen
9699

97100
Other components interact with a given component through its interface rather than the concrete class, as illustrated in the (partial) class diagram below.
98101

99-
<puml src="diagrams/ComponentManagers.puml" width="300" />
102+
<puml src="diagrams/ComponentManagers.puml" width="290" />
100103

101104
<box type="tip" light>
102105

@@ -496,7 +499,7 @@ The following activity diagram summarizes what happens when a user executes a ne
496499

497500
{{ newPageBetween }}
498501

499-
#### Design considerations:
502+
#### Design considerations
500503

501504
**Aspect: How undo & redo executes:**
502505

‎docs/UGContentPage.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## <i class="fa-solid fa-rectangle-list"></i> **Table of Contents**
2+
3+
* [**Navigating this User Guide**](UserGuide.md#navigating-this-user-guide)
4+
* [**Useful Notations and Glossary**](UserGuide.md#useful-notations-and-glossary)
5+
* [Symbols](UserGuide.md#symbols)
6+
* [Keywords](UserGuide.md#keywords)
7+
* [Abbreviations](UserGuide.md#abbreviations)
8+
* [Command Format](UserGuide.md#command-format)
9+
* [Parameters and their Recognized Prefixes](UserGuide.md#parameters-and-their-recognized-prefixes)
10+
* [Other Parameters](UserGuide.md#other-parameters)
11+
* [**Navigating the GUI**](UserGuide.md#navigating-the-gui)
12+
* [**Quick start**](UserGuide.md#quick-start)
13+
* [**Features**](UserGuide.md#features)
14+
* [Viewing help: `help`](UserGuide.md#viewing-help-help)
15+
* [Name/Rename CS course: `setcrs`](UserGuide.md#name-rename-cs-course-setcrs)
16+
* [Adding a student: `addstu`](UserGuide.md#adding-a-student-addstu)
17+
* [Listing all students: `list`](UserGuide.md#listing-all-students-list)
18+
* [Editing a student: `edit`](UserGuide.md#editing-a-student-edit)
19+
* [Locating students by name: `find`](UserGuide.md#locating-students-by-name-find)
20+
* [Marking a student's attendance for a given week by their NUSNet ID: `mark`](UserGuide.md#marking-a-student-s-attendance-for-a-given-week-by-their-nusnet-id-mark)
21+
* [Unmarking a student's attendance for a given week by their NUSNet ID: `unmark`](UserGuide.md#unmarking-a-student-s-attendance-for-a-given-week-by-their-nusnet-id-unmark)
22+
* [Deleting a student: `delstu`](UserGuide.md#deleting-a-student-delstu)
23+
* [Clearing all entries: `clear`](UserGuide.md#clearing-all-entries-clear)
24+
* [Exiting the program: `exit`](UserGuide.md#exiting-the-program-exit)
25+
* [Autocomplete](UserGuide.md#autocomplete)
26+
* [Retrieving command history](UserGuide.md#retrieving-command-history)
27+
* [Saving the data](UserGuide.md#saving-the-data)
28+
* [Editing the data file](UserGuide.md#editing-the-data-file)
29+
* [**Command summary**](UserGuide.md#command-summary)
30+
* [**Known issues**](UserGuide.md#known-issues)
31+
* [**FAQ**](UserGuide.md#faq)
32+
* [Transfering Data to Another Computer](UserGuide.md#transfering-data-to-another-computer)
33+
* [Loading Data from Another Computer](UserGuide.md#loading-data-from-another-computer)
34+
* [Launching TAPro](UserGuide.md#launching-tapro)
35+
* [Checking Java Version](UserGuide.md#checking-java-version)
36+
* [Saving More Time](UserGuide.md#saving-more-time)

‎docs/UserGuide.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ If you can type fast, TAPro can get your contact management and attendance takin
2424
{{ newPageBetween }}
2525

2626
<!-- * Table of Contents -->
27-
<page-nav-print />
28-
27+
<div class="d-none d-print-block">
28+
<include src="UGContentPage.md" />
29+
</div>
2930
{{ newPage }}
3031

3132
## <i class="fa-solid fa-forward"></i> Navigating this User Guide

0 commit comments

Comments
 (0)