farmOS / field-kit

A modular, offline-first companion app to farmOS.
https://farmOS.org
GNU General Public License v3.0
62 stars 39 forks source link

Document Field Module API #492

Open jgaehring opened 2 years ago

jgaehring commented 2 years ago

I'll expand on this later, but here's the general outline:

I can also refer to scrapped 1.x docs for this, even though they're totally wrong, since the API features should at least have an analog to operations for the 2.x API.

A few caveats though...

I'm really not sure about the localization stuff. I won't have time to re-implement it before the release of this API, and I wonder whether I really want to fully document it til then, but it will bear some consideration.

I'm also not sure about what to do with the component library, since Storybook really was the main documentation there, and it's been a real PITA to get up and running again since migrating to Vite/Vue3.