From 0577af9ff9d303b2fd3cb6bd9a93df2747dfa717 Mon Sep 17 00:00:00 2001 From: Julian Date: Tue, 12 Nov 2024 13:07:55 +0800 Subject: [PATCH] Update table of contents --- docs/DeveloperGuide.md | 48 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 9e0896040ee..95c4b4b50e0 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -7,7 +7,53 @@ pageNav: 3 # EduContacts Developer Guide - +## Table of Contents + +1. [Acknowledgements](#acknowledgements) +2. [Setting up, getting started](#setting-up-getting-started) +3. [Design](#design) + - [Architecture](#architecture) + - [UI Component](#ui-component) + - [Logic Component](#logic-component) + - [Model Component](#model-component) + - [Storage Component](#storage-component) + - [Common Classes](#common-classes) +4. [Implementation](#implementation) + - [Module Feature](#module-feature) + - [Grade Feature](#grade-feature) +5. [Documentation, logging, testing, configuration, dev-ops](#documentation-logging-testing-configuration-dev-ops) +6. [Appendix](#appendix) + - [Requirements](#appendix-requirements) + - [Product Scope](#product-scope) + - [User Stories](#user-stories) + - [Use Cases](#use-cases) + - [Non-Functional Requirements](#non-functional-requirements) + - [Glossary](#glossary) + - [Instructions for Manual Testing](#appendix-instructions-for-manual-testing) + - [Launch and Shutdown](#launch-and-shutdown) + - [Commands Testing](#commands-testing) + - [Saving Data](#saving-data) + - [Effort](#appendix-effort) + - [Achievements](#achievements) + - [Effort Required](#effort-required) + - [Challenges Faced](#challenges-faced) + - [Difficulty Level](#difficulty-level) + - [Planned Enhancements](#appendix-planned-enhancements) + - [1. Overly General Error Message for Duplicate Command Word](#1-overly-general-error-message-for-duplicate-command-word) + - [2. Overly General Error Message for Duplicate IDs in Commands](#2-overly-general-error-message-for-duplicate-ids-in-commands) + - [3. Address `help` Command Popup Window Stability Issue](#3-address-help-command-popup-window-stability-issue) + - [4. StudentID as Duplicate Detection Mechanism](#4-studentid-as-duplicate-detection-mechanism) + - [5. Support for Multiple Filter Conditions](#5-support-for-multiple-filter-conditions) + - [6. Toggle for Partial vs Full Matching in Filter Command](#6-toggle-for-partial-vs-full-matching-in-filter-command) + - [7. Support for Additional and Customizable Roles](#7-support-for-additional-and-customizable-roles) + - [8. Support for Contacts Being Tagged with Multiple Roles](#8-support-for-contacts-being-tagged-with-multiple-roles) + - [9. Enhanced Module Utility](#9-enhanced-module-utility) + - [10. Module Not Applicable for Certain Contacts](#10-module-not-applicable-for-certain-contacts) + - [New Features](#appendix-new-features) + - [Undo Command](#undo-command) + - [Data Archiving](#data-archiving) + - [Importing Contact Data](#importing-contact-data) + - [Exporting Contact Data](#exporting-contact-data) --------------------------------------------------------------------------------------------------------------------