elastic / crd-ref-docs

Generates Kubernetes CRD API reference documentation
Apache License 2.0
103 stars 53 forks source link

[Feature Request]: Incorrect links to multi-version CRDs #60

Open tswangdi opened 11 months ago

tswangdi commented 11 months ago

I used crd-ref-docs to generate API documentation for a multi-version CRD.

# API Reference

## Packages
- [example.dev/v1](#exampledevv1)
- [example.dev/v2](#exampledevv2)

## example.dev/v1

### Resource Types
- [Foo](#foo)
- [FooList](#foolist)

#### Foo                        
                                <- Jump to here

## example.dev/v2

### Resource Types
- [Foo](#foo)                   <-  Click this 
- [FooList](#foolist)

#### Foo
                                <- Expect to jump to here

Clicking on the v2 version of Foo redirects to the v1 version of Foo

Refer to the implementation of Kubernetes Docs