Skip to content

NO-ISSUE: docs(reference): regenerate CRD tables and plugin catalog from sources - #173

Closed
gitgod-bot wants to merge 1 commit into
mainfrom
automation/sync-mif-docs-20260818
Closed

NO-ISSUE: docs(reference): regenerate CRD tables and plugin catalog from sources#173
gitgod-bot wants to merge 1 commit into
mainfrom
automation/sync-mif-docs-20260818

Conversation

@gitgod-bot

Copy link
Copy Markdown
Contributor

Changed regions

aigateway-plugins — regenerated content

Sources

heimdall: fc39ec1
heimdall-aigateway: d0b8f0b7
odin: 9f9cb8d

Coverage warnings

Coverage: no gaps detected

@gitgod-bot
gitgod-bot requested a review from a team as a code owner August 18, 2026 12:16
@gitgod-bot
gitgod-bot requested review from seongsu-dev and a lite review from Copilot August 18, 2026 12:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Regenerates reference documentation under website/docs/reference/ from upstream Odin/Heimdall sources, updating CRD field tables and the Heimdall plugin catalog to reflect current behavior.

Changes:

  • Updated Odin InferenceService.spec.inferencePoolRefs documentation to explicitly mark it as deprecated and ignored at runtime.
  • Added the saturation-gate plugin entry to the Heimdall plugin catalog under a new “Others” section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
website/docs/reference/odin/api-reference.mdx Regenerated CRD table content; clarifies inferencePoolRefs deprecation and runtime behavior.
website/docs/reference/heimdall/plugins.mdx Regenerated plugin catalog; includes saturation-gate and groups it under “Others”.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

| --- | --- | --- | --- |
| `framework` | string | no | Framework specifies the inference engine (e.g. vllm, sglang). |
| `inferencePoolRefs` | [array](#inferenceservice-inferencepoolrefs) | no | InferencePoolRefs is a list of references to InferencePools. |
| `inferencePoolRefs` | [array](#inferenceservice-inferencepoolrefs) | no | InferencePoolRefs is a list of references to InferencePools. Deprecated: retained for API compatibility only. The field is ignored at runtime: references are neither resolved at admission nor reflected in the generated Deployment or LeaderWorkerSet. |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seongsu-dev InferencePool관련 정보는 모두 삭제하는 방향으로 진행해주세요.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deprecated가 확인되면 해당 서술을 지우는 방향으로 mimir docs sync 기능을 업데이트해 두겠습니다.

@seongsu-dev

Copy link
Copy Markdown
Contributor

Closing. This run's diff adds the Deprecated: sentence to the inferencePoolRefs row, which points the opposite way from where the field is going: per the review on this PR the row is being removed from the reference altogether, and the generator now leaves out any field whose description opens a Deprecated: paragraph.

The rest of this diff was correct and is not lost — the saturation-gate plugin entry will reappear in the next run's PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants