📝 Zotmeal Docs v1.0

[EightBitByte]

• Ported over internal documentation from the ZotMeal repository
• Added flair with Fumadocs components
• Reorganized documentation into logical folders

[KevinWu098]

Overall, this is really nicely written and easy to follow! I really appreciate you going into detail about core aspects of the application, particularly the backend.

I've added a few specific comments about the getting started section.

---

Additionally, I do want to say that the current draft runs the risk of being overly documented.

Take for instance the ui section. While in theory we would like that every component is documented, in practice it presents two problems:

1. Development drift — as things change (likely rapidly, given the current stage of the project), docs will start to not align with what's actual in dev/prod
2. Ongoing burden — related to drift, this adds additional burden to any new components or changes you make to old components

If you're interested in documenting UI thoroughly, I'd encourage you to checkout Storybook as a (mostly) self-documenting UI solution: https://storybook.js.org/. My suggestion would be to

TL;DR Overly documented can present problems, just as much as being under documented.

This is also true about the present api documentation. Manually writing out the props and returns is not maintainable. More often, this kind of documentation is auto-generated.

For both UI and API, I think it would be more effective and more maintainable if you focused on a given example of an API endpoint or a component rather than over-documenting.

[KevinWu098]

LGTM, thanks for the great work!

[LexTruong]

LGTM