Skip to content

Keep api spec docs in sync with the CRD #169

Open
@tumido

Description

@tumido

Is your feature request related to a problem? Please describe.
ModelService CRD changes time to time but the API spec docs do not reflect this change at the moment.

For instance:

The version 0.0.10 has .spec.endpointPicker available in the CRD:
https://github.com/neuralmagic/llm-d-model-service/blob/82603a9ac88796a9689d6e5c1ad076398b08f48e/api/v1alpha1/modelservice_types.go#L77

But the docs do not advertise it:
https://github.com/neuralmagic/llm-d-model-service/blob/0.0.10/docs/api_reference/out.asciidoc#modelservicespec

Describe the solution approach you'd like
Docs are always in sync with CRD

Describe alternatives you've considered
Manual updates - but that's a chore, please don't do that... 😄

Additional context
We want to reference your docs in the deployer, so we want users to clearly understand what is available and what is not.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions