Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve/generate JSDocs and publish to GitHub pages #175

Open
symbioquine opened this issue Aug 10, 2022 · 1 comment
Open

Improve/generate JSDocs and publish to GitHub pages #175

symbioquine opened this issue Aug 10, 2022 · 1 comment

Comments

@symbioquine
Copy link
Collaborator

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
Copy link
Member

mstenta commented Aug 10, 2022

+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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants