search

farmOS / field-kit

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

Document Field Module API #380

Closed jgaehring closed 4 years ago

jgaehring commented 4 years ago

As we set out to complete the Roadmap (#373), I want to make sure we're documenting the new Field Module API as we go, since that will be the primary focus of the next several milestones.

I'll add a checklist here eventually as we flesh out the API features we'll need. It will correspond pretty closely to the checklist in #373.

jgaehring commented 4 years ago

One important early consideration is where do we want to host this API documentation?

Maybe for a start we just want to add an API.md file in the root of this repo, and eventually find a place for it over on farmos.org. I imagine it will be a fairly substantial API to document, by the time it's done (or at least stable).

Any thoughts on that, @mstenta?

jgaehring commented 4 years ago

I created an API.md file in my PR #382. I've also gone into #373 and added specific line items for documentation for each of the milestones where it applies. So I think I'm actually going to close this in favor of tracking everything from there.

mstenta commented 4 years ago

Any thoughts on that, @mstenta?

Yea we should think about this, as well as the farmOS 2.x documentation, which I am starting to build directly in the farmOS 2.x repository (rather than in the farmOS.org repository). I think the ideal solution would be that we document these things in their repos like this, and then when we convert farmOS.org to Gatsby we pull it in somehow. So the docs can still be directly tied to the code in each repo, but still be "aggregated" into the central farmOS.org in the future.

jgaehring commented 4 years ago

Awesome, I like that idea a lot. I'll proceed as I am with the API.md doc then. Maybe split it into a docs/ directory if it starts to get big. Thanks Mike.