Skip to content

Commit 286437d

Browse files
committed
🤖 fix: remove inline HTML from codercontrolplane API docs
Update the OperatorTokenSecretRef field comment to a single line so generated API reference markdown no longer emits an inline <br />, fixing docs-quality markdownlint failures. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$3.91`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=3.91 -->
1 parent 61464c9 commit 286437d

2 files changed

Lines changed: 2 additions & 3 deletions

File tree

‎api/v1alpha1/codercontrolplane_types.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ type CoderControlPlaneStatus struct {
5252
ReadyReplicas int32 `json:"readyReplicas,omitempty"`
5353
// URL is the in-cluster URL for the control plane service.
5454
URL string `json:"url,omitempty"`
55-
// OperatorTokenSecretRef points to the Secret key containing the
56-
// `coder-k8s-operator` API token.
55+
// OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token.
5756
OperatorTokenSecretRef *SecretKeySelector `json:"operatorTokenSecretRef,omitempty"`
5857
// OperatorAccessReady reports whether operator API access bootstrap succeeded.
5958
OperatorAccessReady bool `json:"operatorAccessReady,omitempty"`

‎docs/reference/api/codercontrolplane.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
| `status.observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
2929
| `status.readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
3030
| `status.url` | `string` | URL is the in-cluster URL for the control plane service. |
31-
| `status.operatorTokenSecretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | OperatorTokenSecretRef points to the Secret key containing the<br />`coder-k8s-operator` API token. |
31+
| `status.operatorTokenSecretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token. |
3232
| `status.operatorAccessReady` | `bool` | OperatorAccessReady reports whether operator API access bootstrap succeeded. |
3333
| `status.phase` | `string` | Phase is a high-level readiness indicator. |
3434
| `status.conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |

0 commit comments

Comments
 (0)