Cutlery/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-05-24 01:12:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

improved docs

Browse Source
This commit is contained in:
Hayden 2021-01-03 19:50:16 -09:00
parent d27ea39279
commit 7387d7f7d5
4 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
dev/dev-notes.md
View File

@ -8,17 +8,19 @@ After the stack is running navigate to the [admin page localhost:9090/settings/s
Once you're up and running you should be able to make changes and see them reflected on the frontend/backend. If you're not sure what to work on you can check:
- The Working Todo's below.
- The Todo's below.
- The [Development Road Map](https://hay-kot.github.io/mealie/2.0%20-%20roadmap/)
- The [Current Open Issues](https://github.com/hay-kot/mealie/issues)
# Working Todos
Don't forget to [join the Discord](https://discord.gg/R6QDyJgbD2)!
# Todo's
Frontend
- [ ] .Vue file reorganized into something that makes sense
- [ ] Recipe Print Page
- [x] Catch 400 / bad response on create from URL
- [ ] Recipe Editor Data Validation CLient Side
- [ ] Recipe Editor Data Validation Client Side
- [x] Favicon
- [x] Rename Window
- [ ] Add version indicator and notification for new version available
@ -29,7 +31,7 @@ Backend
- [x] Add Debug folder for writing the last pulled recipe data to.
- [x] Recipe Editor Data Validation Server Side
- [ ] Normalize Recipe data on scrape
- [ ] Support how to Sections
- [ ] Support how to Sections and how to steps
- [ ] Export Markdown on Auto backups
- [ ] Recipe request by category/tags
- [ ] Add Additional Migrations, See mealie/services/migrations/chowdown.py for examples of how to do this.
@ -37,15 +39,17 @@ Backend
- [ ] NextCloud [See Issue #14](https://github.com/hay-kot/mealie/issues/14)
# Draft Changelog
## v0.0.1
## v0.0.2
General
- Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31)
- Updated Favicon
- Renamed Frontend Window
- Added Debug folder to dump scraper data prior to processing.
- Improved documentation
- Added version tag / relevant links, and new version notifier
Recipes
- Added user feedback on bad URL. Now when
- Added user feedback on bad URL.
- Better backend data validation for updating recipes, avoid small syntax errors corrupting database entry. [Issue #8](https://github.com/hay-kot/mealie/issues/8)
- Fixed spacing issue while editing new recipes in JSON

3
docs/docs/1.0 - getting-started.md
View File

@ -1,6 +1,5 @@
# Getting Started
To deploy docker on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose below you should be able to get a stack up and running easily by changing a few default values and deploying. Currently the only supported database is mongo.
To deploy docker on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose below you should be able to get a stack up and running easily by changing a few default values and deploying. Currently the only supported database is Mongo. Mealie is looking for contributors to support additional databases.
[Get Docker](https://docs.docker.com/get-docker/)

11
docs/docs/2.1 - Contributions.md
View File

@ -7,6 +7,8 @@ We love your input! We want to make contributing to this project as easy and tra
- Proposing new features
- Becoming a maintainer
[Remember to join the Discord and stay in touch with other developers working on the project](https://discord.gg/R6QDyJgbD2)!
## We Develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.
@ -14,10 +16,11 @@ We use github to host code, to track issues and feature requests, as well as acc
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1. Fork the repo and create your branch from `master`.
2. If you've changed APIs, update the documentation.
3. Make sure your code lints.
4. Issue that pull request!
5. If you make changes to the dev/0.1.0 branch reflect those changes in the dev/dev-notes.md to keep track of changes.
2. Read the page in in [dev/dev-notes.md](https://github.com/hay-kot/mealie/blob/0.1.0/dev/dev-notes.md) to get an idea on where the project is at.
3. If you've changed APIs, update the documentation.
4. Make sure your code lints.
5. Issue that pull request!
6. If you make changes to the dev/0.1.0 branch reflect those changes in the dev/dev-notes.md to keep track of changes.
## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

2
docs/docs/index.md
View File

@ -18,6 +18,8 @@
Mealie also provides an API for interactions from 3rd party applications. **Why does my recipe manager need an API?** An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based of Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access any available API from the backend server. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation.
[Remember to join the Discord](https://discord.gg/R6QDyJgbD2)!
!!! note
In some of the demo gifs the styling may be different than the finale application. demos were done during development prior to finale styling.