aiven/aiven-operator

Improve API Reference docs

Closed this issue · 2 comments

The API Reference docs is auto generated from the source code (comments on the Types).

We need an overall look on that and improve the comments accordingly.

We also need to add a Table of Contents.

The main challenge will be to transform the API Reference templates into markdown, since Doscy can't build a TOC for HTML content.

TOC added in #159