Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for recipe JSON zip structure and conversion process #3434

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mygrexit
Copy link

@mygrexit mygrexit commented Dec 9, 2024

So, I couldn’t find any clear docs on how the JSON zip import/export works, so I reverse-engineered (just kidding) it from the files and used ChatGPT/Claude to fit the format. Ended up writing this section on:

  • How the zip structure works (export_YYYY-MM-DD.zip > 6.zip > recipe.json + image.jpeg).
  • Steps for turning grandma’s old recipes into JSON using OCR and AI tools.

Maybe this section of the docs isn't the right place, since it's more of an how-to, but i wanted to share it anway.
If this looks good, I can polish it further or add more examples. Just an idea, let me know what you think! :)

- Documented zip file structure for exporting recipes (`export_YYYY-MM-DD.zip` > `6.zip` > `recipe.json` + `image.jpeg`).
- Added steps to convert physical recipes to JSON using OCR and language models.
- Provided example folder structure for clarity.
@CLAassistant
Copy link

CLAassistant commented Dec 9, 2024

CLA assistant check
All committers have signed the CLA.

@vabene1111
Copy link
Collaborator

hi, thanks for your PR, i really like it and I think it can help a lot of people. What I am unsure about is if this is the right place for it. The main reason is that I lack the time to properly maintain something like this trough updates. This means it will at some point become deprecated and might confuse people.

What do you think about just leaving the section about that JSON import/export is possible in the docs and create a "discussion" in the show and tell area https://github.com/TandoorRecipes/recipes/discussions/categories/show-and-tell which is linked int the docs as something like "community guide to importing and exporting JSON with AI" so people can find it and see the date it was created. Its also easy for people to post about their experiences and share for example their promts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants