diff --git a/docs/docs/assets/img/Toolbox-Categories.webp b/docs/docs/assets/img/Toolbox-Categories.webp new file mode 100644 index 000000000..082dcd584 Binary files /dev/null and b/docs/docs/assets/img/Toolbox-Categories.webp differ diff --git a/docs/docs/assets/img/Toolbox-Organize.webp b/docs/docs/assets/img/Toolbox-Organize.webp new file mode 100644 index 000000000..a90124453 Binary files /dev/null and b/docs/docs/assets/img/Toolbox-Organize.webp differ diff --git a/docs/docs/assets/img/dashboard.webp b/docs/docs/assets/img/dashboard.webp new file mode 100644 index 000000000..11682678f Binary files /dev/null and b/docs/docs/assets/img/dashboard.webp differ diff --git a/docs/docs/assets/img/site-settings.webp b/docs/docs/assets/img/site-settings.webp index 4e0763a7b..49fe8c0aa 100644 Binary files a/docs/docs/assets/img/site-settings.webp and b/docs/docs/assets/img/site-settings.webp differ diff --git a/docs/docs/getting-started/introduction.md b/docs/docs/getting-started/introduction.md index 490cf0cdf..6dd8ad4ff 100644 --- a/docs/docs/getting-started/introduction.md +++ b/docs/docs/getting-started/introduction.md @@ -15,7 +15,7 @@ Mealie is a self hosted recipe manager and meal planner with a RestAPI backend a - 🔍 Fuzzy search - 🏷️ Tag recipes with categories or tags to flexible sorting - 🕸 Import recipes from around the web by URL -- 📱 Beautiful Mobile Views +- 📱 Progressive Web App - 📆 Create Meal Plans - 🛒 Generate shopping lists - 🐳 Easy setup with Docker diff --git a/docs/docs/getting-started/organizing-recipes.md b/docs/docs/getting-started/organizing-recipes.md index 4a8b9a6fe..eb78a4de4 100644 --- a/docs/docs/getting-started/organizing-recipes.md +++ b/docs/docs/getting-started/organizing-recipes.md @@ -19,4 +19,15 @@ Below are some general guidelines that were considered when creating the organiz In the diagram below you will see what we came up with using the new custom pages feature. The large circles indicate pages, and the rectangles indicate categories. We've grouped several 'like' categories with each other as a way to quickly find similar items. -![Mealie Diagram](../../assets/img/mealie-diagram.webp) \ No newline at end of file +![Mealie Diagram](../../assets/img/mealie-diagram.webp) + +## Toolbox +The toolbox gives you multiple options to clean-up and organize your recipes. You can acces it through the 'Settings' menu or through the [dashboard](../site-administration/dashboard.md). + +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) + +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) diff --git a/docs/docs/site-administration/dashboard.md b/docs/docs/site-administration/dashboard.md new file mode 100644 index 000000000..820653812 --- /dev/null +++ b/docs/docs/site-administration/dashboard.md @@ -0,0 +1,13 @@ +#Dashboard + +The dashboard gives you a quick overview of how your Mealie is doing. There is a 'Recipes' card, an overview of the users and groups, an 'Events' card and a 'Backups' card. + +![dashboard](../assets/img/dashboard.webp) + + +##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 +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. diff --git a/docs/docs/site-administration/site-settings.md b/docs/docs/site-administration/site-settings.md index 2ada08ea5..d88e03a1e 100644 --- a/docs/docs/site-administration/site-settings.md +++ b/docs/docs/site-administration/site-settings.md @@ -1,14 +1,15 @@ # Site Settings -Your sites settings panel can only be accessed by administrators. This where you can customize your site for all users. - +Your sites settings panel can only be accessed by administrators. This where you can customize your site for all users. ## Home Page Settings | Option | Description | -| ------------------ | -------------------------------------------------------------- | -| Language | The default site language | +| ------------------ | -------------------------------------------------------------- | | Show Recent | To display the recent recipes section on the home page | | Card Per Section | The amount of cards displayed in each section on the home page | | 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 | ![Site Settings Image](../assets/img/site-settings.webp) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 99b575af0..18da2b21b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -62,6 +62,7 @@ nav: - Site Settings: "site-administration/site-settings.md" - Building Pages: "site-administration/building-pages.md" - User Management: "site-administration/user-management.md" + - Dashboard: "site-administration/dashboard.md" - Backups and Restore: "site-administration/backups-and-exports.md" - Recipe Migration: "site-administration/migration-imports.md" - API Usage: