Add Dashboard documentation (#466)
Add toolbox documentation in organizing-recipes.md Update Images for site settings Update site-settings.md
This commit is contained in:
parent
c8f3d4ba84
commit
cb8e765a61
9 changed files with 32 additions and 6 deletions
BIN
docs/docs/assets/img/Toolbox-Categories.webp
Normal file
BIN
docs/docs/assets/img/Toolbox-Categories.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
BIN
docs/docs/assets/img/Toolbox-Organize.webp
Normal file
BIN
docs/docs/assets/img/Toolbox-Organize.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 334 KiB |
BIN
docs/docs/assets/img/dashboard.webp
Normal file
BIN
docs/docs/assets/img/dashboard.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
Binary file not shown.
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 71 KiB |
|
@ -15,7 +15,7 @@ Mealie is a self hosted recipe manager and meal planner with a RestAPI backend a
|
||||||
- 🔍 Fuzzy search
|
- 🔍 Fuzzy search
|
||||||
- 🏷️ Tag recipes with categories or tags to flexible sorting
|
- 🏷️ Tag recipes with categories or tags to flexible sorting
|
||||||
- 🕸 Import recipes from around the web by URL
|
- 🕸 Import recipes from around the web by URL
|
||||||
- 📱 Beautiful Mobile Views
|
- 📱 Progressive Web App
|
||||||
- 📆 Create Meal Plans
|
- 📆 Create Meal Plans
|
||||||
- 🛒 Generate shopping lists
|
- 🛒 Generate shopping lists
|
||||||
- 🐳 Easy setup with Docker
|
- 🐳 Easy setup with Docker
|
||||||
|
|
|
@ -20,3 +20,14 @@ 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.
|
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)
|
![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)
|
||||||
|
|
13
docs/docs/site-administration/dashboard.md
Normal file
13
docs/docs/site-administration/dashboard.md
Normal file
|
@ -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.
|
|
@ -1,14 +1,15 @@
|
||||||
# Site Settings
|
# 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
|
## Home Page Settings
|
||||||
| Option | Description |
|
| Option | Description |
|
||||||
| ------------------ | -------------------------------------------------------------- |
|
| ------------------ | -------------------------------------------------------------- |
|
||||||
| Language | The default site language |
|
|
||||||
| Show Recent | To display the recent recipes section on the home page |
|
| 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 |
|
| 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 |
|
| 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)
|
![Site Settings Image](../assets/img/site-settings.webp)
|
||||||
|
|
||||||
|
|
|
@ -62,6 +62,7 @@ nav:
|
||||||
- Site Settings: "site-administration/site-settings.md"
|
- Site Settings: "site-administration/site-settings.md"
|
||||||
- Building Pages: "site-administration/building-pages.md"
|
- Building Pages: "site-administration/building-pages.md"
|
||||||
- User Management: "site-administration/user-management.md"
|
- User Management: "site-administration/user-management.md"
|
||||||
|
- Dashboard: "site-administration/dashboard.md"
|
||||||
- Backups and Restore: "site-administration/backups-and-exports.md"
|
- Backups and Restore: "site-administration/backups-and-exports.md"
|
||||||
- Recipe Migration: "site-administration/migration-imports.md"
|
- Recipe Migration: "site-administration/migration-imports.md"
|
||||||
- API Usage:
|
- API Usage:
|
||||||
|
|
Loading…
Reference in a new issue