https://github.com/grocy/docs
Documentation for https://github.com/grocy/grocy
https://github.com/grocy/docs
Last synced: 7 months ago
JSON representation
Documentation for https://github.com/grocy/grocy
- Host: GitHub
- URL: https://github.com/grocy/docs
- Owner: grocy
- License: mit
- Created: 2019-10-23T13:28:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T13:38:17.000Z (over 2 years ago)
- Last Synced: 2025-01-05T03:49:07.547Z (9 months ago)
- Homepage: https://grocy.info
- Size: 3.8 MB
- Stars: 28
- Watchers: 9
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Looking for the docs
Continue to the [Grocy documentation](tutorial.md) or look below for some stuff about the docs and how to help improve them.
# About docs
This repository is for creating documentation for the grocy project. You can find grocy at https://github.com/grocy/grocy
The four types of documentation that will be needed are:
1. tutorials - learning-oriented, gets first-time users up and running
2. how-tos - problem-oriented, answers specific scenarios
3. explanations - understanding-oriented, gets contributors up and running
4. reference - information-oriented, serves as a repository of knowledge for contributors
This project will first focus on tutorials. This means that:
- the target audience of these writings are first- and second-time users of Grocy.
- the structure should reflect their exploration of functionality
- technical debt should be minimal
- the language should be clear, with short sentences and an informal tone
The main tutorial page is [tutorial.md](tutorial.md)
# Feedback
Please leave an issue if you think there is a topic that needs further documentation and is not planned yet. (See planned sections below.)
## Planned sections for tutorials
- [x] Why use Grocy?
- [x] Setup
- Installation (step by step guide)
- Setting up users
- User specific settings
- General settings
- [x] Use: track your food!
- Manage master data
- Purchase
- Stock overview
- Transfer
- Consume
- Inventory
- Shopping list
- [x] Use: track your cooking!
- Recipes
- Meal plan
- [ ] Use: track your things!
- Batteries
- Equipment
- [ ] Use: track your chores and tasks!
- Chores overview
- Tasks
- Chore tracking
- [X] Examples
- [ ] Update to 3.0
- FAQ (?)