holos-run / holos

Holos - The Holistic platform manager
https://holos.run
Apache License 2.0
1 stars 0 forks source link

docs/website: generate v1alpha2 api docs from source (#196) #197

Closed jeffmccune closed 2 months ago

jeffmccune commented 2 months ago

The API docs are not published yet becuase the module is private. Our own docs site does not have any API reference docs.

This patch adds auto-generated markdown docs for the core v1alpha2 types by generating them directly from the go source code.

Some light editing of the output of gomarkdoc is necessary to get the heading anchor tags to align correctly for Docusaurus.

Closes: #196