Skip to content

Add auto-generated API reference documentation #5

New issue
New issue
Open
Open
Add auto-generated API reference documentation#5
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.
@ajaysundark

Description

@ajaysundark
ajaysundark
opened on Nov 24, 2025

As the project evolves, we have to make it accessible for someone wants to discover our CRD fields and understand what they do. Users who want to know "what can I configure?" need not have to dig through the Go code

Proposed Solution

Set up auto-generated API docs like crd-ref-docs (or other common tooling in kubernetes-sigs projects).

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions