Skip to content

chore: API documentation sync - #621

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
auto-sync
Open

chore: API documentation sync#621
github-actions[bot] wants to merge 1 commit into
mainfrom
auto-sync

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Automated pull request to sync docs for:

  • Console operator
  • Deployment operator
  • Liquid filters

@github-actions
github-actions Bot requested a review from a team as a code owner September 1, 2026 00:22
@github-actions
github-actions Bot enabled auto-merge (squash) September 1, 2026 00:22
@greptile-apps

greptile-apps Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This automated documentation sync adds REVIEW as an agent run mode and documents the new optional reviewDepth field.

  • Expands the documented AgentRunMode options with REVIEW.
  • Adds reviewDepth to the agent run specification.

Confidence Score: 4/5

The documentation should be corrected before merging because the new reviewDepth type link is broken and provides no valid-value definition.

The newly documented field points to a nonexistent in-page type definition, preventing API consumers from discovering its accepted values.

Files Needing Attention: pages/api-reference/kubernetes/agent-api-reference.md

Important Files Changed

Filename Overview
pages/api-reference/kubernetes/agent-api-reference.md Adds REVIEW mode and reviewDepth, but the new type link points to a definition that is absent from the page.

Reviews (1): Last reviewed commit: "sync docs" | Re-trigger Greptile

| `branch` _string_ | Branch is the repository branch the agent should operate on. If omitted, the repository default branch is used. | | Optional: \{\} <br /> |
| `mode` _[AgentRunMode](#agentrunmode)_ | Mode defines how the agent should run (ANALYZE, WRITE) | | Required: \{\} <br /> |
| `mode` _[AgentRunMode](#agentrunmode)_ | Mode defines how the agent should run (ANALYZE, WRITE, REVIEW) | | Required: \{\} <br /> |
| `reviewDepth` _[AgentReviewDepth](#agentreviewdepth)_ | ReviewDepth controls how far a review run explores code adjacent to the pull request changes. | | Optional: \{\} <br /> |

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.

P1 AgentReviewDepth definition is missing

When a reader follows the new AgentReviewDepth link to determine the accepted reviewDepth values, it targets an absent #agentreviewdepth definition, leaving the field's valid values undocumented.

Knowledge Base Used: API reference rendering

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant