diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 59aff479755..f4be66f9fce 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,6 +33,10 @@ show-toc: true ## Command Summary +### General Commands + +{% include_relative _ug/commandSummary/GeneralCommands.md %} + ### Item Commands {% include_relative _ug/commandSummary/ItemCommands.md %} @@ -41,9 +45,10 @@ show-toc: true {% include_relative _ug/commandSummary/TagCommands.md %} -### Other Commands +### Statistics Command + +{% include_relative _ug/commandSummary/StatisticsCommands.md %} -{% include_relative _ug/commandSummary/OtherCommands.md %} ## Troubleshooting diff --git a/docs/_glossary/GraphicalUserInterface.md b/docs/_glossary/GraphicalUserInterface.md new file mode 100644 index 00000000000..308e820aed3 --- /dev/null +++ b/docs/_glossary/GraphicalUserInterface.md @@ -0,0 +1,6 @@ +--- +name: Graphical User Interface +show-in: [ug, dg] +--- + +A Graphical User Interface is a graphics-based interface that uses icons, menus and a mouse (to click on the icon or pull down the menus) to manage interaction with the system. In FoodRem, this presents as the window that appears when launching it. diff --git a/docs/_ug/About.md b/docs/_ug/About.md index ee62b778ca4..39d4ac7379f 100644 --- a/docs/_ug/About.md +++ b/docs/_ug/About.md @@ -1,6 +1,6 @@ -FoodRem is an Inventory Management System that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's Inventory Management System, where you can manage your inventory during your daily operations. Utilize FoodRem's flexible tagging system to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's statistics, keeping track of vital data such as food wastage. +FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's own **Inventory Management System**, where you can manage your inventory during your daily operations. Utilize FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's **statistics**, keeping track of vital data such as food wastage. -Using a Command-Line interface, efficiently interact with FoodRem without needing to even touch your mouse! With a focus on user-friendliness, FoodRem is easy to learn! +Simply by typing, efficiently interact with FoodRem without ever needing to touch your mouse! With a focus on user-friendliness, FoodRem is easy to learn! -This User Guide provides an in-depth documentation to help integrate FoodRem into your operational workflows. It covers how to launch FoodRem, core FoodRem features and commands, common terms and definitions used in FoodRem, and some troubleshooting recommendations. In addition, a quick start guide is available that gives a whirlwind tour to help get you started. +This User Guide provides an in-depth documentation to help integrate FoodRem into your operational workflows. It covers how to launch FoodRem, core FoodRem features and commands, common terms and definitions used in FoodRem, and some troubleshooting recommendations. In addition, a [quick start guide](#how-to-use-the-user-guide) is available that gives a whirlwind tour to help get you started. diff --git a/docs/_ug/Commands.md b/docs/_ug/Commands.md index 4170c59d1d2..b0a53f16c97 100644 --- a/docs/_ug/Commands.md +++ b/docs/_ug/Commands.md @@ -14,7 +14,7 @@ What you should expect to find: * For each command, "Format" indicates the syntax of the command. * Square brackets indicates an optional parameter. -* In most commands, if more parameters are provided, we take the last value provided. +* In most commands, if the same parameter is repeated and only one is required, we take the last value provided. ### General Commands diff --git a/docs/_ug/FAQ.md b/docs/_ug/FAQ.md index 6406773b07c..eb4ffb3ce5b 100644 --- a/docs/_ug/FAQ.md +++ b/docs/_ug/FAQ.md @@ -5,7 +5,7 @@ **Q:** Do I need internet connection to run FoodRem?
**A:** No, FoodRem can boot up and run all functionalities without an internet connection. -**Q:** Can I use FooRem on my mobile device?
+**Q:** Can I use FoodRem on my mobile device?
**A:** Unfortunately, no. FoodRem is designed to run on your desktop/laptop such that you can use the command line interface. **Q:** How do I transfer my data to another Computer?
diff --git a/docs/_ug/HowToUseUserGuide.md b/docs/_ug/HowToUseUserGuide.md index 9426d43e6ec..56ae387c451 100644 --- a/docs/_ug/HowToUseUserGuide.md +++ b/docs/_ug/HowToUseUserGuide.md @@ -1,23 +1,21 @@ -Thank you for choosing FoodRem! We are delighted to have you as a user and aim to serve you well. +Thank you for choosing FoodRem! We are delighted to have you as a user and we aim to serve you and your business well! -We **highly recommend** that you read through the User Guide in a **sequential order** up until the section [Features](#features), where you can find all the information you need before using any commands. +```tip +We **highly recommend** that you read through the User Guide in a **sequential order**. Please note the importance of the [Using FoodRem](#using-foodrem) section, which covers how to use FoodRem! +``` If you have not installed FoodRem head over to the [Installation](#installation) section. -Once FoodRem is installed, you can head over to the section [Using FoodRem](#using-foodrem) which will share with you the basics of FoodRem. This includes: +Once FoodRem is installed, you can head over to the section [Using FoodRem](#using-foodrem) which covers the basics of using FoodRem. This includes: -* FoodRem [Layout](#layout) -* [Items and Tags](#items-and-tags) in FoodRem -* FoodRem [Command Format](#command-format). -* [Flags](#flags) and [Placeholders](#placeholders): - * Important syntax you will come across while reading the User Guide such as `n/`, `bgt/` or `INDEX`, `ITEM_NAME`. - * The description of all syntax and how to use them -* [Trying out](#trying-your-first-command) your first command. +* FoodRem's [Layout](#layout) +* What [Items and Tags](#items-and-tags) are in FoodRem +* Using FoodRem's [Commands](#command-format) +* What [Flags](#flags) and [Placeholders](#placeholders) are +* [Trying out](#trying-your-first-command) your first command -If you are an experienced user, you can refer to the [Command Summary](#command-summary) to get an overview of all currently supported FoodRem commands. - -Here are some icons you may encounter in FoodRem and what they mean: +If you are an experienced user, you can refer to the [Command Summary](#command-summary) for a quick overview of all of FoodRem's commands. If you are stuck, refer to the section on [Troubleshooting](#troubleshooting) or [FAQ](#faq). diff --git a/docs/_ug/ItemsTags.md b/docs/_ug/KeyDefinitions.md similarity index 54% rename from docs/_ug/ItemsTags.md rename to docs/_ug/KeyDefinitions.md index 97bff31957e..31a62a2d587 100644 --- a/docs/_ug/ItemsTags.md +++ b/docs/_ug/KeyDefinitions.md @@ -7,11 +7,11 @@ The following are the attributes stored for each item: * Item name * Item quantity -* Item unit (Unit of measurement e.g. `kg`, `packets`) +* Item unit (unit of measurement e.g. `kg`, `packets`) * Item bought date * Item expiry date * Item price -* Item remark +* Item remarks * Item tags FoodRem Items are unique by name and case-sensitive. This means you cannot add two or more items of the same name. @@ -33,3 +33,33 @@ Feel free to add tags as you see fit to organize your inventory. Examples of how Tags can be renamed and these changes would be reflected on all items immediately. FoodRem Tags are unique by name and case-sensitive. This means you cannot add two or more tags of the same name. + +#### Flags + +Flags are delimiters that enable FoodRem to distinguish different parameters without ambiguity. + +You would put in the corresponding [Placeholder](#placeholders) immediately after each flag. + +Please refer to the [Command Format](#command-format) to see how Flags and Placeholders are used together. + +| Flag | Corresponding Placeholder | +|------|---------------------------| +| n/ | ITEM_NAME
TAG_NAME | +| qty/ | QUANTITY | +| u/ | UNIT | +| bgt/ | BOUGHT_DATE | +| exp/ | EXPIRY_DATE | +| p/ | PRICE | +| r/ | REMARKS | + +#### Placeholders + +Placeholders show you what type of parameters you can supply to a command. These follow immediately after a [Flag](#flag). + +Please refer to the [Command Format](#command-format) to see how Flags and Placeholders are used together. + +```note +The placeholders `INDEX`, `COMMAND_WORD`, and `KEYWORD` do not have any corresponding flags. They are marked as "Not Applicable" in the table below. +``` + +{% include_relative _ug/Placeholders.md %} diff --git a/docs/_ug/Layout.md b/docs/_ug/Layout.md index a12b9986c01..51e292437f5 100644 --- a/docs/_ug/Layout.md +++ b/docs/_ug/Layout.md @@ -1,15 +1,15 @@ -Let us look at the layout of the different components of FoodRem. +When you launch FoodRem, FoodRem appears on your screen as a [Graphical User Interface](#graphical-user-interface), or GUI. Let's look at the layout of the different components of FoodRem. -FoodRem application: +**FoodRem's GUI:** ![FullUiImage](images/FoodRemFullUi.png) -This table breaks down the different components of the FoodRem. +This table breaks down the different components of FoodRem's GUI. -| Name | Description | +| Name | Image | |--------------------|--------------------------------------------------| | Command Input Box | ![CommandInputBox](images/CommandInputBox.png) | | Command Output Box | ![CommandOutputBox](images/CommandOutputBox.png) | diff --git a/docs/_ug/Placeholders.md b/docs/_ug/Placeholders.md index c305d35be62..97ee7bd3086 100644 --- a/docs/_ug/Placeholders.md +++ b/docs/_ug/Placeholders.md @@ -30,19 +30,19 @@ {% capture TABLE %} -| Placeholders | Related Flags | Description | -|--------------|---------------|----------------| -| INDEX | | :INDEX: | -| ITEM_NAME | n/ | :ITEM_NAME: | -| TAG_NAME | n/ | :TAG_NAME: | -| QUANTITY | qty/ | :QUANTITY: | -| UNIT | u/ | :UNIT: | -| BOUGHT_DATE | bgt/ | :BOUGHT_DATE: | -| EXPIRY_DATE | exp/ | :EXPIRY_DATE: | -| PRICE | p/ | :PRICE: | -| REMARKS | r/ | :REMARKS: | -| COMMAND_WORD | | :COMMAND_WORD: | -| KEYWORD | | :KEYWORD: | +| Placeholder | Corresponding Flag | Description | +|--------------|---------------------|----------------| +| INDEX | (Not Applicable) | :INDEX: | +| ITEM_NAME | n/ | :ITEM_NAME: | +| TAG_NAME | n/ | :TAG_NAME: | +| QUANTITY | qty/ | :QUANTITY: | +| UNIT | u/ | :UNIT: | +| BOUGHT_DATE | bgt/ | :BOUGHT_DATE: | +| EXPIRY_DATE | exp/ | :EXPIRY_DATE: | +| PRICE | p/ | :PRICE: | +| REMARKS | r/ | :REMARKS: | +| COMMAND_WORD | (Not Applicable) | :COMMAND_WORD: | +| KEYWORD | (Not Applicable) | :KEYWORD: | {% endcapture %} diff --git a/docs/_ug/TryingFirstCommand.md b/docs/_ug/TryingFirstCommand.md index 9d008221b1e..cd2da532cc0 100644 --- a/docs/_ug/TryingFirstCommand.md +++ b/docs/_ug/TryingFirstCommand.md @@ -4,16 +4,25 @@ To let you become more familiar with FoodRem, let's practice executing some comm To start off, let's try out the `new` command! This command lets you add an [Item](#item) to FoodRem. -The format for commands are not identical. - One of the available commands in FoodRem is the command to create a new item. **Format:** `new n/ITEM_NAME [qty/QUANTITY] [u/UNIT] [bgt/BOUGHT_DATE] [exp/EXPIRY_DATE] [p/PRICE] [r/REMARKS]` -The first word of every command allows FoodRem to distinguish different commands. `new` tells FoodRem that this is the command to create a new item. [Flags](#flags) such as `n/` and `qty/` are delimiters that enable FoodRem to distinguish different parameters supplied by you without ambiguity. [Placeholders](#placeholders) such as `ITEM_NAME` and `QUANTITY` shows you what you should place in each portion of the command. +**What does the format mean?** + +The first word of every command allows FoodRem to distinguish different commands. +* `new` tells FoodRem that this is the command to create a new item. +* [Flags](#flags) such as `n/` and `qty/` are delimiters that enable FoodRem to distinguish different parameters supplied by you without ambiguity. +* [Placeholders](#placeholders) such as `ITEM_NAME` and `QUANTITY` shows you what you should place in each portion of the command. Notice that there is a pair of square brackets `[]` surrounding some parameters like `qty/QUANTITY` in the format. This indicates that the parameter is **optional**. Each of these placeholders have a default value based on the commands. These are documented in the [Commands](#commands) section for each command. +```note +The [Placeholder](#placeholders) section covers the restrictions for respective placeholders. For example, the date format of BOUGHT_DATE, certain characters you cannot use and the limit and precision of numbers. +``` + +**Let's try an example!** + Suppose you just bought 30 kg worth of potatoes, today is 5th September 2022, and you do not feel the need to record an expiry date, price or remarks for this item. `ITEM_NAME`: Potatoes @@ -24,35 +33,35 @@ Suppose you just bought 30 kg worth of potatoes, today is 5th September 2022, an `BOUGHT_DATE`: 05-09-2022 -```note -The [Placeholder](#placeholders) section covers the restrictions for respective placeholders. For example, the date format of BOUGHT_DATE, certain characters you cannot use and the limit and precision of numbers. -``` - The command you would like to enter into the command box would be: `new n/Potatoes qty/30 u/kg bgt/05-09-2022` -Alternatively these command would do the same thing: +Alternatively, executing these would do the same thing: -* `new qty/30 n/Potatoes bgt/05-09-2022 u/kg` (Reordering the flags) -* `new qty/100 n/Carrots qty/30 n/Potatoes bgt/05-09-2022 u/kg` (Only last parameters are taken if multiple parameters are provided) +* `new qty/30 n/Potatoes bgt/05-09-2022 u/kg` _(Reordering the flags)_ +* `new qty/100 n/Carrots qty/30 n/Potatoes bgt/05-09-2022 u/kg` _(Only last parameters are taken if multiple parameters are provided)_ -These commands are invalid: +However, note that the following executions are invalid: -* `newn/Potatoesqty/30u/kgbgt/05-09-2022` (Removing spaces between the placeholders and flags) -* `new qty/-48 n/PÖtátÖes bgt/05/09/22 u/|kg|` (Restrictions of placeholders not followed) -* `new` (Insufficient information provided) +* `newn/Potatoesqty/30u/kgbgt/05-09-2022` _(Removing spaces between the placeholders and flags)_ +* `new qty/-48 n/PÖtátÖes bgt/05/09/22 u/|kg|` _(Restrictions of placeholders not followed)_ +* `new` _(Insufficient information provided, you must minimally provide a name)_ _Find out more about restrictions in the sections [Flags](#flags), [Placeholders](#placeholders) and [Commands](#commands)._ --- -Let's try out another command - the `inc` command! `inc` tells FoodRem that this is the command to increment the quantity of an item. +Let's try out another command - the `inc` command! `inc` lets you increment the quantity of an item. + +```warning +The format for different commands are not always identical. For example, executing the `new` command and the `inc` command will have different formats! +``` For example, after creating the potatoes item, you decided to buy 40 kg more of potatoes. -Format: `inc INDEX [qty/QUANTITY]` +**Format:** `inc INDEX [qty/QUANTITY]` -Suppose the `INDEX` for potatoes is `1` in the application, the command you would like to enter into the command box would be: +Suppose the `INDEX` for potatoes is `1` in the application, the command you would like to enter into the [Command Input Box)(#layout) would be: `inc 1 qty/40` diff --git a/docs/_ug/UsingFoodRem.md b/docs/_ug/UsingFoodRem.md index 66e0b4b902a..4abf1643413 100644 --- a/docs/_ug/UsingFoodRem.md +++ b/docs/_ug/UsingFoodRem.md @@ -1,13 +1,14 @@ -Here is an overview of what FoodRem consists of and how you can perform a command. + +This section covers all you should know about FoodRem, as well as a [guided tutorial](#trying-your-first-command). Of special note is the [Key Definitions](#key-definitions) and [Command Format](#command-format) sections, which covers essential knowledge to using FoodRem's features. ### Layout {% include_relative _ug/Layout.md %} -### Items and Tags +### Key Definitions -{% include_relative _ug/ItemsTags.md %} +{% include_relative _ug/KeyDefinitions.md %} ### Command Format @@ -19,29 +20,9 @@ Here is an example: A command consists of: -1. Command Word to tell FoodRem what action you wish to execute. These actions are covered in [Commands](#commands) -1. [Flags](#flags) to distinguish parameters -1. [Placeholders](#placeholders) that you can replace with your parameter inputs - -### Flags - -Flags are delimiters that enable FoodRem to distinguish different parameters without ambiguity. - -| Flags | Related Placeholder | -|-------|-----------------------| -| n/ | ITEM_NAME
TAG_NAME | -| qty/ | QUANTITY | -| u/ | UNIT | -| buy/ | BOUGHT_DATE | -| exp/ | EXPIRY_DATE | -| p/ | PRICE | -| r/ | REMARKS | - -### Placeholders - -Placeholders are words in uppercase to show you what type of parameters you can supply to a command. - -{% include_relative _ug/Placeholders.md %} +1. Command Word: Tells FoodRem what action you wish to execute. These actions are covered in [Commands](#commands). +1. [Flags](#flags): Distinguishes between inputs. This follows before your Placeholder data. +1. [Placeholders](#placeholders): Represents data that you wish to input. Replace this with valid data. For example, `ITEM_NAME` in `n/ITEM_NAME` can be replaced with `n/Potato`. Placeholders should follow after a Flag. ### Trying your first command diff --git a/docs/_ug/commandSummary/OtherCommands.md b/docs/_ug/commandSummary/GeneralCommands.md similarity index 76% rename from docs/_ug/commandSummary/OtherCommands.md rename to docs/_ug/commandSummary/GeneralCommands.md index ac574a8fdd2..eb61cf7d9a9 100644 --- a/docs/_ug/commandSummary/OtherCommands.md +++ b/docs/_ug/commandSummary/GeneralCommands.md @@ -2,17 +2,17 @@ -{% capture help %}{% include_relative _ug/commandSummary/otherCommands/help.md %}{% endcapture %} -{% capture reset %}{% include_relative _ug/commandSummary/otherCommands/reset.md %}{% endcapture %} -{% capture exit %}{% include_relative _ug/commandSummary/otherCommands/exit.md %}{% endcapture %} +{% capture help %}{% include_relative _ug/commandSummary/generalCommands/help.md %}{% endcapture %} +{% capture reset %}{% include_relative _ug/commandSummary/generalCommands/reset.md %}{% endcapture %} +{% capture exit %}{% include_relative _ug/commandSummary/generalCommands/exit.md %}{% endcapture %} {% assign help = help | markdownify %} {% assign reset = reset | markdownify %} {% assign exit = exit | markdownify %} -{% capture helpexample %}{% include_relative _ug/commandSummary/otherCommandsExamples/help.md %}{% endcapture %} -{% capture resetexample %}{% include_relative _ug/commandSummary/otherCommandsExamples/reset.md %}{% endcapture %} -{% capture exitexample %}{% include_relative _ug/commandSummary/otherCommandsExamples/exit.md %}{% endcapture %} +{% capture helpexample %}{% include_relative _ug/commandSummary/generalCommandsExamples/help.md %}{% endcapture %} +{% capture resetexample %}{% include_relative _ug/commandSummary/generalCommandsExamples/reset.md %}{% endcapture %} +{% capture exitexample %}{% include_relative _ug/commandSummary/generalCommandsExamples/exit.md %}{% endcapture %} {% assign helpexample = helpexample | markdownify %} {% assign resetexample = resetexample | markdownify %} diff --git a/docs/_ug/commandSummary/StatisticsCommands.md b/docs/_ug/commandSummary/StatisticsCommands.md new file mode 100644 index 00000000000..6c5fc5966f4 --- /dev/null +++ b/docs/_ug/commandSummary/StatisticsCommands.md @@ -0,0 +1,24 @@ + + + + +{% capture stats %}{% include_relative _ug/commandSummary/statisticsCommands/stats.md %}{% endcapture %} +{% assign stats = stats | markdownify %} +{% capture statsexample %}{% include_relative _ug/commandSummary/statisticsCommandsExamples/stats.md %}{% endcapture %} +{% assign statsexample = statsexample | markdownify %} + + + + +{% capture TABLE %} +| Action | Format | Example | +|-------------------------------------------------------|---------|----------------| +| Displays relevant statistics tracked by FoodRem | :stats: | :statsexample: | +{% endcapture %} + + +{{ TABLE +| markdownify +| replace: ":stats:", stats +| replace: ":statsexample:", statsexample +}} diff --git a/docs/_ug/commandSummary/otherCommands/exit.md b/docs/_ug/commandSummary/generalCommands/exit.md similarity index 100% rename from docs/_ug/commandSummary/otherCommands/exit.md rename to docs/_ug/commandSummary/generalCommands/exit.md diff --git a/docs/_ug/commandSummary/otherCommands/help.md b/docs/_ug/commandSummary/generalCommands/help.md similarity index 100% rename from docs/_ug/commandSummary/otherCommands/help.md rename to docs/_ug/commandSummary/generalCommands/help.md diff --git a/docs/_ug/commandSummary/otherCommands/reset.md b/docs/_ug/commandSummary/generalCommands/reset.md similarity index 100% rename from docs/_ug/commandSummary/otherCommands/reset.md rename to docs/_ug/commandSummary/generalCommands/reset.md diff --git a/docs/_ug/commandSummary/otherCommandsExamples/exit.md b/docs/_ug/commandSummary/generalCommandsExamples/exit.md similarity index 100% rename from docs/_ug/commandSummary/otherCommandsExamples/exit.md rename to docs/_ug/commandSummary/generalCommandsExamples/exit.md diff --git a/docs/_ug/commandSummary/otherCommandsExamples/help.md b/docs/_ug/commandSummary/generalCommandsExamples/help.md similarity index 100% rename from docs/_ug/commandSummary/otherCommandsExamples/help.md rename to docs/_ug/commandSummary/generalCommandsExamples/help.md diff --git a/docs/_ug/commandSummary/otherCommandsExamples/reset.md b/docs/_ug/commandSummary/generalCommandsExamples/reset.md similarity index 100% rename from docs/_ug/commandSummary/otherCommandsExamples/reset.md rename to docs/_ug/commandSummary/generalCommandsExamples/reset.md diff --git a/docs/_ug/commandSummary/statisticsCommands/stats.md b/docs/_ug/commandSummary/statisticsCommands/stats.md new file mode 100644 index 00000000000..e24c0d50910 --- /dev/null +++ b/docs/_ug/commandSummary/statisticsCommands/stats.md @@ -0,0 +1,2 @@ + +`stats` diff --git a/docs/_ug/commandSummary/statisticsCommandsExamples/stats.md b/docs/_ug/commandSummary/statisticsCommandsExamples/stats.md new file mode 100644 index 00000000000..e24c0d50910 --- /dev/null +++ b/docs/_ug/commandSummary/statisticsCommandsExamples/stats.md @@ -0,0 +1,2 @@ + +`stats` diff --git a/docs/_ug/commands/ItemCommands.md b/docs/_ug/commands/ItemCommands.md index 245d27dde00..17d976043d0 100644 --- a/docs/_ug/commands/ItemCommands.md +++ b/docs/_ug/commands/ItemCommands.md @@ -1,5 +1,5 @@ -Example of [Item](#item): +Example of an [Item](#item): ![Item](images/ItemImage.png) @@ -93,7 +93,9 @@ Item List Box: * The `KEYWORDS` are case-insensitive. (e.g. "apples" will match "Apples"). * The order of the `KEYWORDS` do not matter (e.g "rose apple" will match "apple rose"). * The result will be items in which `ITEM_NAME` contain any one of the `KEYWORDS` provided. -* You can use the [List Command](#List) to display all items again. +``` +```tip +* You can use the [List Command](#list-all-items-list) to display all items again! ``` **Example Input:** @@ -124,8 +126,8 @@ Item List Box: > Sorts the list of currently displayed items by the provided criteria -```info -* Only one sorting criteria is to be provided. +```warning +You should only provide one sorting criteria. ``` **Example Input:** diff --git a/docs/_ug/commands/TagCommands.md b/docs/_ug/commands/TagCommands.md index 4a90cdab615..055f28781a5 100644 --- a/docs/_ug/commands/TagCommands.md +++ b/docs/_ug/commands/TagCommands.md @@ -1,5 +1,5 @@ -Example of [Tag](#tag): +Example of a [Tag](#tag): ![Tags](images/TagImage.png) diff --git a/docs/_ug/placeholders/ITEM_NAME.md b/docs/_ug/placeholders/ITEM_NAME.md index bb83c5e0f3c..0aa82227ed5 100644 --- a/docs/_ug/placeholders/ITEM_NAME.md +++ b/docs/_ug/placeholders/ITEM_NAME.md @@ -4,7 +4,7 @@ The ITEM_NAME is the name we use to identify an item. ```info * ITEM_NAME is a short text with a limit of 200 characters * ITEM_NAME can contain alphanumeric characters, spaces, and the following symbols: `?` `'` `.` `"` `[` `]` `{` `}` `(` `)` `+` `^` `$` `*` `-` `,` `:` `;` `@` `!` `#` `%` `&` `_` `=` -* ITEM_NAME is unique and case*insensitive +* ITEM_NAME is unique and case-insensitive * ITEM_NAME will have leading and trailing spaces trimmed * ITEM_NAME cannot be blank ``` diff --git a/docs/_ug/placeholders/KEYWORD.md b/docs/_ug/placeholders/KEYWORD.md index 5a48ac24be7..ca6b14610da 100644 --- a/docs/_ug/placeholders/KEYWORD.md +++ b/docs/_ug/placeholders/KEYWORD.md @@ -1,5 +1,5 @@ -The KEYWORD is the text we use to search for an item +The KEYWORD is the text we use to search for an item. ```info * KEYWORD is a short text diff --git a/docs/images/CommandInputBox.png b/docs/images/CommandInputBox.png index 8f48684a23d..774e40928a7 100644 Binary files a/docs/images/CommandInputBox.png and b/docs/images/CommandInputBox.png differ diff --git a/docs/images/CommandOutputBox.png b/docs/images/CommandOutputBox.png index 38092652c08..a45f73b03fc 100644 Binary files a/docs/images/CommandOutputBox.png and b/docs/images/CommandOutputBox.png differ diff --git a/docs/images/FoodRemFullUi.png b/docs/images/FoodRemFullUi.png index e229898d166..e06fb2739e2 100644 Binary files a/docs/images/FoodRemFullUi.png and b/docs/images/FoodRemFullUi.png differ diff --git a/docs/images/ItemImage.png b/docs/images/ItemImage.png index b9b218ae85d..dba8fe82348 100644 Binary files a/docs/images/ItemImage.png and b/docs/images/ItemImage.png differ diff --git a/docs/images/ItemListBox.png b/docs/images/ItemListBox.png index a58c020cf26..82b378b42b1 100644 Binary files a/docs/images/ItemListBox.png and b/docs/images/ItemListBox.png differ