search

farmOS / farmOS-map

farmOS-map is an OpenLayers wrapper library designed for agricultural mapping needs. It can be used in any project that has similar requirements.
https://farmOS.github.io/farmOS-map
MIT License
35 stars 21 forks source link

Improve/generate JSDocs and publish to GitHub pages #175

Open symbioquine opened 1 year ago

symbioquine commented 1 year ago

The readme for farmOS-map is already pretty long but even now there are details that aren't documented there. Publishing improving the inline documentation via JSDoc and publishing the resulting static documentation to GitHub pages would provide a way for the documentation to grow without making the readme even more unapproachable in length.

mstenta commented 1 year ago

+100! This will be a great next step.

publishing the resulting static documentation to GitHub pages

If we produce markdown, perhaps we should publish to https://farmos.org/development/farmos-map/ instead (like we do for https://farmos.org/development/farmos-js/ and https://farmos.org/development/farmos-py/).

I've never used JSDoc so I don't really know what's possible/what it will look like. Happy to help if I can!