I believe a significant portion of the documentation will need to address the API for utils and lib on the global farmOS namespace.
They're basically what they say on the tin; utils contains some functions like parseNotes and mergeGeometries that are useful throughout the individual module components, while right now lib just includes the wellknown library for parsing WKT, but I'm also planning to include Ramda as soon as the need arises. It might also be good to add the Vue constructor and/or main instance, possibly Vuex as well.
The farmOS namespace also includes farmOS-map, although I'm not sure how to document that, since I'm intending the primary interface for maps to be the <farm-map> component instead.
I'm adding this to the 0.9.0 milestone, b/c it seems like that will be a good time to decide exactly what is needed and what isn't, when we're actually sprinting on new modules and should have a pretty good sense of that.
I believe a significant portion of the documentation will need to address the API for
utils
andlib
on the globalfarmOS
namespace.They're basically what they say on the tin;
utils
contains some functions likeparseNotes
andmergeGeometries
that are useful throughout the individual module components, while right nowlib
just includes thewellknown
library for parsing WKT, but I'm also planning to include Ramda as soon as the need arises. It might also be good to add theVue
constructor and/or main instance, possiblyVuex
as well.The
farmOS
namespace also includes farmOS-map, although I'm not sure how to document that, since I'm intending the primary interface for maps to be the<farm-map>
component instead.I'm adding this to the 0.9.0 milestone, b/c it seems like that will be a good time to decide exactly what is needed and what isn't, when we're actually sprinting on new modules and should have a pretty good sense of that.