From 93cc596ebb3ebe8bdc111bbf48d5b1a0158a65ee Mon Sep 17 00:00:00 2001 From: isaaceng7 <110762696+isaaceng7@users.noreply.github.com> Date: Mon, 15 Apr 2024 22:20:13 +0800 Subject: [PATCH] Add table of contents to UG --- docs/UserGuide.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index df0674158..b3ac6e20e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,5 +1,26 @@ # User Guide +## Table of Contents +- [Introduction](#introduction) +- [Quick Start](#quick-start) +- [Features](#features) + - [Viewing help: `help`](#viewing-help-help) + - [Adding a transaction: `add`](#adding-a-transaction-add) + - [View transaction history: `list`](#view-transaction-history-list) + - [Deleting a transaction: `delete`](#deleting-a-transaction-delete) + - [Edit a transaction: `edit`](#edit-a-transaction-edit) + - [Search for a transaction: `search`](#search-for-a-transaction-search) + - [Add an account: `add-acc`](#add-an-account-add-acc) + - [List all accounts: `list-acc`](#list-all-accounts-list-acc) + - [Delete an account: `delete-acc`](#delete-an-account-delete-acc) + - [Edit an account: `edit-acc`](#edit-an-account-edit-acc) + - [View transaction insights: `insights`](#view-transaction-insights-insights) + - [Exiting the program: `bye`](#exiting-the-program-bye) + - [Saving the data](#saving-the-data) + - [Editing the data file](#editing-the-data-file) +- [FAQ](#faq) +- [Command Summary](#command-summary) + ## Introduction BudgetBuddy is a **desktop app for managing personal finances, optimized for use via a Command Line Interface** (CLI). @@ -277,8 +298,6 @@ the data of your previous BudgetBuddy home folder. ## Command Summary -{Give a 'cheat sheet' of commands here} - * View help `help` * View help for all commands `help all`. This can be used to see all the commands related to transactions * View help for accounts `help acc`. This can be used to see all the commands related to account