search

UpstreamDataInc / goosebit

A simplistic, opinionated remote update server implementing hawkBit™'s DDI API.
https://goosebit.rtfd.io
Apache License 2.0
18 stars 3 forks source link

Update documentation #99

Closed b-rowan closed 2 months ago

b-rowan commented 2 months ago

Fixes some issues with the github pages docs deployment, and moves some documentation around to hopefully make it a bit more readable.

Had to disable the full check-yaml hook for mkdocs.yml to enable loading environment variables with ENV!.

b-rowan commented 2 months ago

LGTM with my limited understanding in this area.

Main question: will we substantially shorten the README.md once this is deployed and working?

It won't affect the current README, but we may want to update it. I'm not really sure the best way to structure a README vs general documentation, but I'm sure it'll get improved as time goes on.