API documentation

[marquiz]

What would you like to be added:

Better documentation of the API(s), preferable by auto-generating with e.g. https://github.com/elastic/crd-ref-docs. We'd need to document api/nfd and api/image-compatibility.

Why is this needed:

Better documentation, always up-to-date (if auto-generated)

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[fmuyassarov]

/remove-lifecycle stale

[fmuyassarov]

/remove-lifecycle stale

[fmuyassarov]

If I can, I would suggest https://kubespec.dev