forked from nus-cs2103-AY2324S2/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #325 from tituschewxj/fix-dg-4
docs: Update DG and UG content page
- Loading branch information
Showing
4 changed files
with
84 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| ## **Table of Contents** | ||
|
|
||
| * [**Acknowledgements**](DeveloperGuide.md#acknowledgements) | ||
| * [**Setting up, getting started**](DeveloperGuide.md#setting-up-getting-started) | ||
| * [**Design**](DeveloperGuide.md#design) | ||
| * [Architecture](DeveloperGuide.md#architecture) | ||
| * [UI component](DeveloperGuide.md#ui-component) | ||
| * [Logic component](DeveloperGuide.md#logic-component) | ||
| * [Model component](DeveloperGuide.md#model-component) | ||
| * [Storage component](DeveloperGuide.md#storage-component) | ||
| * [Common classes](DeveloperGuide.md#common-classes) | ||
| * [**Implementation**](DeveloperGuide.md#implementation) | ||
| * [Autocomplete Feature](DeveloperGuide.md#autocomplete-feature) | ||
| * [Command History Retrieval](DeveloperGuide.md#command-history-retrieval) | ||
| * [[Proposed] Undo/Redo Feature](DeveloperGuide.md#proposed-undo-redo-feature) | ||
| * [**Documentation, logging, testing, configuration, dev-ops**](DeveloperGuide.md#documentation-logging-testing-configuration-dev-ops) | ||
| * [**Appendix: Requirements**](DeveloperGuide.md#appendix-requirements) | ||
| * [Product scope](DeveloperGuide.md#product-scope) | ||
| * [User stories](DeveloperGuide.md#user-stories) | ||
| * [Use cases](DeveloperGuide.md#use-cases) | ||
| * [Non-Functional Requirements](DeveloperGuide.md#non-functional-requirements) | ||
| * [Glossary](DeveloperGuide.md#glossary) | ||
| * [**Appendix: Instructions for manual testing**](DeveloperGuide.md#appendix-instructions-for-manual-testing) | ||
| * [Launch and shutdown](DeveloperGuide.md#launch-and-shutdown) | ||
| * [Adding a student](DeveloperGuide.md#adding-a-student) | ||
| * [Editing a student](DeveloperGuide.md#editing-a-student) | ||
| * [Deleting a student](DeveloperGuide.md#deleting-a-student) | ||
| * [Finding a student](DeveloperGuide.md#finding-a-student) | ||
| * [Marking a student's attendance](DeveloperGuide.md#marking-a-student-s-attendance) | ||
| * [Unmarking a student's attendance](DeveloperGuide.md#unmarking-a-student-s-attendance) | ||
| * [Setting the course name](DeveloperGuide.md#setting-the-course-name) | ||
| * [Autocompleting fields](DeveloperGuide.md#autocompleting-fields) | ||
| * [Retrieving previous successful commands](DeveloperGuide.md#retrieving-previous-successful-commands) | ||
| * [Accessing help](DeveloperGuide.md#accessing-help) | ||
| * [Clearing all data](DeveloperGuide.md#clearing-all-data) | ||
| * [**Appendix: Design Decisions**](DeveloperGuide.md#appendix-design-decisions) | ||
| * [**Appendix: Effort**](DeveloperGuide.md#appendix-effort) | ||
| * [**Appendix: Planned Enhancements**](DeveloperGuide.md#appendix-planned-enhancements) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| ## <i class="fa-solid fa-rectangle-list"></i> **Table of Contents** | ||
|
|
||
| * [**Navigating this User Guide**](UserGuide.md#navigating-this-user-guide) | ||
| * [**Useful Notations and Glossary**](UserGuide.md#useful-notations-and-glossary) | ||
| * [Symbols](UserGuide.md#symbols) | ||
| * [Keywords](UserGuide.md#keywords) | ||
| * [Abbreviations](UserGuide.md#abbreviations) | ||
| * [Command Format](UserGuide.md#command-format) | ||
| * [Parameters and their Recognized Prefixes](UserGuide.md#parameters-and-their-recognized-prefixes) | ||
| * [Other Parameters](UserGuide.md#other-parameters) | ||
| * [**Navigating the GUI**](UserGuide.md#navigating-the-gui) | ||
| * [**Quick start**](UserGuide.md#quick-start) | ||
| * [**Features**](UserGuide.md#features) | ||
| * [Viewing help: `help`](UserGuide.md#viewing-help-help) | ||
| * [Name/Rename CS course: `setcrs`](UserGuide.md#name-rename-cs-course-setcrs) | ||
| * [Adding a student: `addstu`](UserGuide.md#adding-a-student-addstu) | ||
| * [Listing all students: `list`](UserGuide.md#listing-all-students-list) | ||
| * [Editing a student: `edit`](UserGuide.md#editing-a-student-edit) | ||
| * [Locating students by name: `find`](UserGuide.md#locating-students-by-name-find) | ||
| * [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) | ||
| * [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) | ||
| * [Deleting a student: `delstu`](UserGuide.md#deleting-a-student-delstu) | ||
| * [Clearing all entries: `clear`](UserGuide.md#clearing-all-entries-clear) | ||
| * [Exiting the program: `exit`](UserGuide.md#exiting-the-program-exit) | ||
| * [Autocomplete](UserGuide.md#autocomplete) | ||
| * [Retrieving command history](UserGuide.md#retrieving-command-history) | ||
| * [Saving the data](UserGuide.md#saving-the-data) | ||
| * [Editing the data file](UserGuide.md#editing-the-data-file) | ||
| * [**Command summary**](UserGuide.md#command-summary) | ||
| * [**Known issues**](UserGuide.md#known-issues) | ||
| * [**FAQ**](UserGuide.md#faq) | ||
| * [Transfering Data to Another Computer](UserGuide.md#transfering-data-to-another-computer) | ||
| * [Loading Data from Another Computer](UserGuide.md#loading-data-from-another-computer) | ||
| * [Launching TAPro](UserGuide.md#launching-tapro) | ||
| * [Checking Java Version](UserGuide.md#checking-java-version) | ||
| * [Saving More Time](UserGuide.md#saving-more-time) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters