diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a05d97361d4..0c20f4493fa 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -5,7 +5,7 @@ title: User Guide Choose a topic from the table of contents to get started on your **Wishful Shrinking journey**. -##Table of Contents +## Table of Contents 1. [Overview](#1-overview) - [1.1. Introduction](#11-introduction) @@ -27,7 +27,8 @@ Choose a topic from the table of contents to get started on your **Wishful Shrin * [5.1.7 Closing the recipe drawer : `close`](#close-recipe) * [5.1.8 Searching for a recipe: `searchR`](#search-recipe) * [5.1.9 Recommending recipes : `recommend`](#recommend-recipe) - * [5.1.10 Clearing all recipes : `clearR`](#clear-recipe) + * [5.1.10 Clearing all recipes : `clearR`](#clear-recipe) +
- [5.2 Fridge-related Commands](#52-ingredient-related-commands) * [5.2.1 Adding an ingredient: `addF`](#add-ingredient) * [5.2.2 Listing all ingredients : `fridge`](#list-ingredient) @@ -35,12 +36,14 @@ Choose a topic from the table of contents to get started on your **Wishful Shrin * [5.2.4 Editing an ingredient: `editF`](#edit-ingredient) * [5.2.5 Getting an ingredient to edit: `editF`](#get-edit-ingredient) * [5.2.6 Searching for an Ingredient: `searchF`](#search-ingredient) - * [5.2.7 Clearing all ingredients : `clearF`](#clear-ingredient) + * [5.2.7 Clearing all ingredients : `clearF`](#clear-ingredient) +
- [5.3 Consumption-related Commands](#53-consumption-related-commands) * [5.3.1 Eating a recipe : `eatR`](#eat-consumption) * [5.3.2 Listing all recipes eaten : `calories`](#list-consumption) * [5.3.3 Deleting a recipe eaten: `deleteC`](#delete-consumption) - * [5.3.4 Clearing all consumed recipes : `clearC`](#clear-consumption) + * [5.3.4 Clearing all consumed recipes : `clearC`](#clear-consumption) +
- [5.4 Miscellaneous Commands](#54-miscellaneous-commands) * [5.4.1 Viewing help : `help`](#help) * [5.4.2 Exiting the program : `exit`](#exit) @@ -50,7 +53,7 @@ Choose a topic from the table of contents to get started on your **Wishful Shrin 8. [Command Summary](#8-command-summary) - + # 1. Overview Welcome to the Wishful Shrinking User Guide! In this section, you will be given an overview of what Wishful @@ -78,21 +81,21 @@ This section will explain the symbols in the user guide, and the format and para ## 2.1 Symbols Symbol | Meaning ---------|------------------ -:memo | This symbol indicates information to take note of. -:bulb | This symbol indicates a helpful tip when using the command. +-------|------------------ +:memo: | This symbol indicates information to take note of. +:bulb: | This symbol indicates a helpful tip when using the command. ## 2.2 Parameters Prefix | Parameter | Meaning --------|----------|-------- -[]()| INDEX | Index of item in the displayed item list n/ | NAME | Name of recipe or name of ingredient i/ | INGREDIENT | Ingredient name and optional quantity instr/ | INSTRUCTION | Instructions of a recipe c/ | CALORIE | Calories of a recipe -img/ IMAGE | Image address of a recipe +img/ | IMAGE | Image address of a recipe t/ | TAG | Recipe tag +[]()| INDEX | Index of item in the displayed item list ## 2.3 Format