Documentation (#474)

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>

docs/docs/documentation/admin/dashboard.md

@@ -5,9 +5,12 @@ The dashboard gives you a quick overview of how your Mealie is doing. There is a
 ![dashboard](../../assets/img/dashboard.webp)
 
 
-##Recipes
+## Recipes
 'Recipes' shows how many recipes you have in your catalogue but also checks if you have any untagged or uncategorized ones. If you click on one of these, you are redirected to the Toolbox where you can further organize these recipes.
 
-##Backups
+## Users
+This gives an overview of the total number of users for your Mealie instance. The 'manage users' and 'manage groups' button will redirect you to the [user-management page](../admin/dashboard.md)
+
+## Backups
 Here you can choose to import an older backup from a previous instance. You could also create a custom backup with your own tag where you can choose for a full backup or only some parts like recipes, users,...
 If you click 'create', an automatic backup is generated.

docs/docs/documentation/admin/site-settings.md

@@ -9,7 +9,7 @@ Your sites settings panel can only be accessed by administrators. This where you
 | Home Page Sections | Category sections to include on the home page                  |
 | Language           | The default site language                                      |
 | First day of the week | The default start day of the week used in Meal Plans        |
-| Custom Pages | Create a custom page which appears in the sidebar with the categories you chose       |
+| Custom Pages | Create a [custom page](../admin/building-pages.md) which appears in the sidebar with the categories you chose       |
 
 ![Site Settings Image](../../assets/img/site-settings.webp)
 

docs/docs/documentation/admin/user-management.md

@@ -83,4 +83,4 @@ You can easily create and manage groups via the frontend in the admin panel unde
     User Groups can only be deleted if no users are apart of the group. If you want to delete a group, you must assign the users to another group before removing. 
 
 ## Password Reset
-If a user forgets their password an administrator is able to reset their password through the user management page. In the user table, select edit. In the popup windows click the "Reset Password" to reset a users password to the default. This is either 'MyPassword' or set through an environment variable. See the [Installation Page](/mealie/getting-started/install/) for more details on environmental variables 
+If a user forgets their password an administrator is able to reset their password through the user management page. In the user table, select edit. In the popup windows click the "Reset Password" to reset a user's password to the default. This is either 'MyPassword' or set through an environment variable. See the [Installation Page](../getting-started/install.md) for more details on environmental variables 

docs/docs/documentation/recipes/recipes.md

@@ -1,7 +1,9 @@
 # Recipes
 
 ## URL Import
-Adding a recipe can be as easy as copying the recipe URL into mealie and letting the web scrapper try to pull down the information. Currently this scraper is implemented with [scrape-schema-recipe package](https://pypi.org/project/scrape-schema-recipe/). You may have mixed results on some websites, especially with blogs or non specific recipe websites. See the bulk import Option below for another a convenient way to add blog style recipes into Mealie.
+Adding a recipe can be as easy as clicking in the bottom-right corner, copying the recipe URL into Mealie and letting the web scrapper organize information. Currently this scraper is implemented with [scrape-schema-recipe package](https://pypi.org/project/scrape-schema-recipe/). You may have mixed results on some websites, especially with blogs or non-specific recipe websites. See the bulk import Option below for another a convenient way to add blog style recipes into Mealie.
+You can add different sections to make sure your recipe is divided correctly into separate 'chapters'
+![](../../assets/gifs/URL-import.gif)
 
 ## Using Bookmarklets
 
@@ -17,14 +19,15 @@ window.open(dest, '_blank')
 ```
 
 ## Recipe Editor
-Recipes can be edited and created via the UI. This is done with both a form based approach where you have a UI to work with as well as with a in browser JSON Editor. The JSON editor allows you to easily copy and paste data from other sources. 
+Recipes can be edited and created via the UI. This is done with both a form based approach where you have a UI to work with as well as with a in browser JSON Editor. The JSON editor allows you to easily copy and paste data from other sources.
+![edit-recipe](../../assets/img/edit-recipe.webp)
 
 You can also add a custom recipe with the UI editor built into the web view.
 
 ## Bulk Import
 Mealie also supports bulk import of recipe instructions and ingredients. Select "Bulk Add" in the editor and paste in your plain text data to be parsed. Each line is treated as one entry and will be appended to the existing ingredients or instructions if they exist. Empty lines will be stripped from the text.
 
-![](../assets/gifs/bulk-add-demo.gif)
+![](../../assets/gifs/bulk-add-demo.gif)
 
 ## Schema 
 Recipes are stored in the json-like format in mongoDB and then sent and edited in json format on the frontend. Each recipes uses [Recipe Schema](https://schema.org/Recipe) as a general guide with some additional properties specific to Mealie.
@@ -32,71 +35,81 @@ Recipes are stored in the json-like format in mongoDB and then sent and edited i
 ### Example
 ```json
 {
-    _id: ObjectId('5fcdc3d715f131e8b191f642'),
+  "id": 263,
-    name: 'Oat and Pecan Brittle Cookies',
+  "name": "Homemade Mac and Cheese Bites",
-    description: 'A gorgeously textured cookie with crispy-edges, a chewy center, toasty pecans, and tiny crispy pecan brittle bits throughout.',
+  "slug": "homemade-mac-and-cheese-bites",
-    image: 'oat-and-pecan-brittle-cookies.jpg',
+  "image": "no image",
-    recipeYield: 'Makes about 18',
+  "description": "These are so simple and the perfect finger food ideal for serving kids and as an appetizer! These are DELICIOUS",
-    recipeIngredient: [
+  "recipeCategory": [],
-        '1¼ cups (142 g) coarsely chopped pecans',
+  "tags": [],
-        '¾ cup (150 g) granulated sugar',
+  "rating": null,
-        '4 Tbsp. (½ stick) unsalted butter',
+  "dateAdded": "2021-06-07",
-        '½ tsp. baking soda',
+  "dateUpdated": "2021-06-07T16:23:10.254840",
-        '½ tsp. Diamond Crystal or ¼ tsp. Morton kosher salt',
+  "recipeYield": null,
-        '1 cup (2 sticks) unsalted butter, cut into 16 pieces, divided',
+  "recipeIngredient": [
-        '1⅓ cups (173 g) all-purpose flour',
+    "½ pound elbow macaroni",
-        '2 tsp. Diamond Crystal or 1 tsp. Morton kosher salt',
+    "2 Tablespoons butter",
-        '1 tsp. baking soda',
+    "2 Tablespoons flour",
-        '2 cups (200 g) old-fashioned oats, divided',
+    "1½ cups milk",
-        '¾ cup (packed; 150 g) dark brown sugar',
+    "2 cups shredded sharp cheddar cheese",
-        '½ cup (100 g) granulated sugar',
+    "2 ounces cream cheese",
-        '2 large eggs',
+    "½ teaspoon salt",
-        '1 Tbsp. vanilla extract'
+    "¼ teaspoon pepper",
-    ],
+    "1 egg beaten"
-    recipeInstructions: [
+  ],
-        {
+  "recipeInstructions": [
-            '@type': 'HowToStep',
+    {
-            text: 'Place a rack in middle of oven; preheat to 350°. Toast pecans on a small rimmed baking sheet, tossing halfway through, until slightly darkened and fragrant, 8–10 minutes. Let cool.'
+      "title": "Preperation",
-        },
+      "text": "Preheat oven to 400 degrees F."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'Line another small rimmed baking sheet with a Silpat baking mat. Cook granulated sugar, butter, and 2 Tbsp. water in a small saucepan over medium-low heat, stirring gently with a heatproof rubber spatula, until sugar is dissolved. Increase heat to medium and bring syrup to a rapid simmer. Cook, without stirring, swirling pan often, until syrup turns a deep amber color, 8–10 minutes. Immediately remove saucepan from heat and stir in pecans. Once pecans are well coated, add baking soda and salt and stir to incorporate (mixture will foam and sputter as baking soda aerates caramel). Working quickly (it will harden fast), scrape mixture onto prepared baking sheet and spread into a thin layer. Let cool completely, 5–10 minutes. Chop into pea-size pieces; set aside.'
+      "title": "",
-        },
+      "text": "Spray mini muffin tins with cooking spray."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'Place half of butter (½ cup) in the bowl of a stand mixer. Bring remaining butter to a boil in a small saucepan over medium-low heat, stirring often with a heatproof rubber spatula. Cook, scraping bottom and sides of pan constantly, until butter sputters, foams, and, eventually, you see browned bits floating on the surface, 5–7 minutes. Pour brown butter over butter in stand mixer bowl, making sure to scrape in all the browned bits. Let sit until butter begins to resolidify, about 30 minutes.'
+      "title": "",
-        },
+      "text": "Cook pasta according to packaged directions and set aside."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'Pulse flour, salt, and baking soda in a food processor to combine. Add half of reserved pecan brittle and 1 cup oats; process in long pulses until oats and brittle are finely ground.'
+      "title": "Cooking",
-        },
+      "text": "In a medium size pan combine butter and flour over medium heat. Whisk until butter is melted and mixture is smooth. Slowly add milk and bring to a simmer. Add 1½ cups of the cheese, cream cheese, salt and pepper. Stir until smooth and creamy. Remove from heat."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'Add brown sugar and granulated sugar to butter and beat with paddle attachment on medium speed until light and smooth but not fluffy, about 2 minutes. Scrape down sides of bowl and add eggs and vanilla. Beat until very light and satiny, about 1 minute. Scrape down sides of bowl and add flour mixture; beat on low speed until no dry spots remain and you have a soft, evenly mixed dough. Add remaining half of brittle and remaining 1 cup oats; mix on low speed just to distribute. Fold batter several times with a spatula to ensure everything is evenly mixed.'
+      "title": "",
-        },
+      "text": "In a large mixing bowl, carefully stir pasta, cheese sauce, and egg until evenly mixed and pasta is evenly coated."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'Using a 2-oz. scoop or ¼-cup measuring cup, scoop level portions of dough to make 18 cookies. Place on a parchment-lined baking sheet, spacing as close together as possible (you’ll space them out before baking). Cover tightly with plastic wrap and chill at least 12 hours and up to 2 days. (If you’re pressed for time, a couple hours will do; cookies just won’t be as chewy.)'
+      "title": "",
-        },
+      "text": "Spoon mac and cheese into mini muffin tins and top each with a small pinch of remaining cheese. Bake at 400 degrees F for 15 minutes or until golden brown."
-        {
+    },
-            '@type': 'HowToStep',
+    {
-            text: 'When ready to bake, place racks in upper and lower thirds of oven; preheat to 350°. Line 2 large rimmed baking sheets with parchment paper. Arrange 6 cookies on each prepared baking sheet, spacing at least 3" apart.'
+      "title": "",
-        },
+      "text": "Allow to cool 5 minutes before gently removing the bites."
-        {
+    }
-            '@type': 'HowToStep',
+  ],
-            text: 'Bake cookies, rotating baking sheets top to bottom and front to back after 12 minutes, until dark golden brown around the edges, 16–20 minutes. Let cookies cool 5 minutes on baking sheets, then transfer cookies to a wire rack with a spatula and let cool completely.'
+  "nutrition": {
-        },
+    "calories": null,
-        {
+    "fatContent": null,
-            '@type': 'HowToStep',
+    "proteinContent": null,
-            text: 'Carefully move a rack to middle of oven. Arrange remaining dough on one of the baking sheets (it’s okay if it’s still warm). Bake as before (this batch might go a bit faster).\nDo ahead: Dough can be formed 2 months ahead; chill dough balls at least 2 hours before transferring to freezer. Once frozen solid, store in resealable plastic freezer bags and keep frozen. No need to thaw before baking, but you may need to add a minute or two to the baking time. Cookies can be baked 5 days ahead; store airtight at room temperature.'
+    "carbohydrateContent": null,
-        }
+    "fiberContent": null,
-    ],
+    "sodiumContent": null,
-    slug: 'oat-and-pecan-brittle-cookies',
+    "sugarContent": null
-    tags: [],
+  },
-    categories: [],
+  "tools": [],
-    dateAdded: ISODate('2020-12-07T05:55:35.434Z'),
+  "totalTime": null,
-    notes: [],
+  "prepTime": null,
-    orgURL: 'https://www.bonappetit.com/recipe/oat-and-pecan-brittle-cookies',
+  "performTime": null,
-    rating: 3
+  "settings": {
+    "public": true,
+    "showNutrition": true,
+    "showAssets": true,
+    "landscapeView": true
+  },
+  "assets": [],
+  "notes": [],
+  "orgURL": "https://www.chef-in-training.com/homemade-mac-and-cheese-bites/",
+  "extras": {},
+  "comments": []
 }
 ```

docs/docs/documentation/toolbox/bulk-organize.md

@@ -1,4 +0,0 @@
-# Bulk Organize
-The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
-
-![Toolbox-Organize](../../assets/img/Toolbox-Organize.webp)

docs/docs/documentation/toolbox/category-tag-editor.md

@@ -1,5 +0,0 @@
-# Category and Tag Editor
-
-The 'Categories' and 'Tags' tab give you the option to bulk assign categories and tags to multiple recipes. You could also remove the unused ones or title case them all.
-
-![Toolbox-Categories](../../assets/img/Toolbox-Categories.webp)

docs/docs/documentation/toolbox/toolbox-intro.md

@@ -1,6 +1,21 @@
-# Getting External Notifications
+#Toolbox
+The toolbox gives you multiple options to clean-up and organize your recipes. You can get notified through different channels.
+You can access it through the 'Settings' menu or through the [dashboard](../admin/dashboard.md).
 
-## Apprise
+
+## Category and Tag Editor
+The 'Categories' and 'Tags' tab give you the option to bulk assign categories and tags to multiple recipes. You could also remove the unused ones or title case them all.
+
+![Toolbox-Categories](../../assets/img/Toolbox-Categories.webp)
+
+## Bulk Organize
+The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
+
+![Toolbox-Organize](../../assets/img/Toolbox-Organize.webp)
+
+## External Notifications
+
+### Apprise
 
 Using the [Apprise](https://github.com/caronc/apprise/) library Mealie is able to provided notification services for nearly every popular service. Some of our favorites are...
 
@@ -10,10 +25,10 @@ Using the [Apprise](https://github.com/caronc/apprise/) library Mealie is able t
 - [Matrix](https://github.com/caronc/apprise/wiki/Notify_matrix)
 - [Pushover](https://github.com/caronc/apprise/wiki/Notify_pushover)
 
-But there are some many to choose from! Take a look at their wiki for information on how to create their URL formats and that you can use to create a notification integration in Mealie. 
+But there are some many to choose from! Take a look at their wiki for information on how to create their URL formats and that you can use to create a notification integration in Mealie.
 
 
-## Subscribe Events
+### Subscribe Events
 There are several categories of events that mealie logs that can be broadcast with the notifications feature. You can also see a feed of your events in the Admin Dashboard
 
 - General Events
@@ -37,23 +52,23 @@ There are several categories of events that mealie logs that can be broadcast wi
 In most cases the events will also provide details on which user performed the action. Now you'll know when your grandma deletes your favorite recipe!
 
 !!! info
-    This is a new feature and we are still working through all the possibilities of events. if you have an idea for an event let us know! 
+This is a new feature and we are still working through all the possibilities of events. if you have an idea for an event let us know!
 
 
-## Creating a New Notification
+### Creating a New Notification
 
 New events can be created and viewed in admin Toolbox `/admin/toolbox?tab=event-notifications`. Select the "+ Notification" button and you'll be provided with a dialog. Complete the form using the URL for the service you'd like to connect to. Before saving be sure to use the test feature.
 
 !!! tip
-    The feedback provided from the test feature is only an indicated of if the URL you provided is valid, not if the message was successfully sent. Be sure to check the notification feed for the test message.
+The feedback provided from the test feature is only an indicated of if the URL you provided is valid, not if the message was successfully sent. Be sure to check the notification feed for the test message.
 
 ![Add Notification Image](../../assets/img/add-notification.webp)
 
 
-## Examples
+### Examples
 
-### Discord
+#### Discord
 ![Discord](../../assets/img/discord-notification-example.webp)
 
-### Gotify
+#### Gotify
 ![Gotify](../../assets/img/gotify-notification-example.webp)

docs/docs/documentation/users-groups/meal-planner.md

@@ -1,13 +1,14 @@
 # Meal Planner
 
-## Working with Meal Plans
+## Working with Planner
-In Mealie you can create a meal plan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and search through recipes to find your choice. After selecting a recipe for all meals save the plan. You can also randomly generate meal plans.
+In Mealie you can create a meal plan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. 
-
+You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and search through recipes to find your choice. Add a side-dish if you prefer to. After selecting a recipe for all meals, save the plan. 
-To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similarly, to delete a meal plan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan.
+You can also randomly generate meal plans with the dice-button at the bottom. 
 
+To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similarly, to delete a meal plan click the delete button on the card in the timeline. Currently, there is no support to change the date range in a meal plan.
 
 ## Shopping Lists
 For any meal plan created you can view a breakdown of all the ingredients and use an experimental sort function to sort similarly ingredients. This is a very new feature and results of the auto sort may vary. 
 
-![](../../assets/gifs/meal-plan-demo-v2.gif)
+![](../../assets/gifs/meal-planner-demoV3.gif)
 

docs/docs/documentation/users-groups/shopping-lists.md

@@ -1 +0,0 @@
-# Shopping Lists

docs/docs/documentation/users-groups/user-settings.md

@@ -12,14 +12,14 @@ In as users profile they are able to
 - Upgrade Profile Picture (Experimental)
 
 ## Themes
-Color themes can be created and set from the UI in the users settings page. You can select an existing color theme or create a new one. On creation of a new color theme, the default colors will be used, then you can select and save as you'd like. By default the "default" theme will be loaded for all new users visiting the site. All created color themes are available to all users of the site. Theme Colors will be set for both light and dark modes.
+Color themes can be created and set from the UI in the Settings-Profile page. You can select an existing color theme or create a new one. On creation of a new color theme, the default colors will be used, then you can select and save as you'd like. By default, the "default" theme will be loaded for all new users visiting the site. All created color themes are available to all users of the site. Theme Colors will be set for both light and dark modes.
 
-![](../../assets/gifs/theme-demo-v2.gif)
+![](../../assets/gifs/theme-demo-v3.gif)
 
 !!! tip
     Theme data is stored in local storage in the browser. Calling "Save colors and apply theme will refresh the local storage with the selected theme as well save the theme to the database. 
 
 ## Group & Meal Plan
-In the meal planner section a user can select categories to be used as apart of the random recipe selector in the meal plan creator. If no categories are selected, all recipes will be used
+In the meal planner section a user can select categories to be used as a part of the random recipe selector in the meal plan creator. If no categories are selected, all recipes will be used
 
 Meal planner webhooks are post requests sent from Mealie to an external endpoint. The body of the message is the Recipe JSON of the scheduled meal. If no meal is schedule, no request is sent. The webhook functionality can be enabled or disabled as well as scheduled. Note that you must "Save" prior to any changes taking affect server side. 

docs/mkdocs.yml

@@ -61,8 +61,6 @@ nav:
       - Users & Groups:
           - User Settings: "documentation/users-groups/user-settings.md"
           - Planning Meals: "documentation/users-groups/meal-planner.md"
-          - Shopping Lists: "documentation/users-groups/shopping-lists.md"
-
       - Admin:
           - Dashboard: "documentation/admin/dashboard.md"
           - Site Settings: "documentation/admin/site-settings.md"
@@ -71,9 +69,7 @@ nav:
           - Backups and Restore: "documentation/admin/backups-and-exports.md"
           - Recipe Migration: "documentation/admin/migration-imports.md"
       - Toolbox:
-          - Event Notifications: "documentation/toolbox/notifications.md"
+          - Toolbox: "documentation/toolbox/toolbox-intro.md"
-          - Category Tag Editor: "documentation/toolbox/category-tag-editor.md"
-          - Bulk Organizer: "documentation/toolbox/bulk-organize.md"
 
       - Community Guides:
           - iOS Shortcuts: "documentation/community-guide/ios.md"