Skip to content

docs: update rpk ai plugin docs (0.2.33) #1877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeSCahill merged 1 commit into from
Aug 4, 2026
Merged

docs: update rpk ai plugin docs (0.2.33) #1877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 52 additions & 8 deletions docs-data/rpk-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@
"flags": "g"
},
{
"description": "Wrap bare flag with adjacent format/value word as inline code before auto-backtick step splits them (e.g. -f json -> `\u200c-f json`, --format yaml -> `--format yaml`)",
"description": "Wrap bare flag with adjacent format/value word as inline code before auto-backtick step splits them (e.g. -f json -> `‌-f json`, --format yaml -> `--format yaml`)",

@coderabbitai coderabbitai Bot Aug 3, 2026

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.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove the remaining invisible character from the example.

The description still contains a hidden character between the opening backtick and -f. Remove it so users can copy the example without corrupting the flag.

python - <<'PY'
import json
from pathlib import Path

data = json.loads(Path("docs-data/rpk-overrides.json").read_text())
rule = next(
    rule for rule in data["textTransformations"]["replacements"]
    if rule["description"].startswith("Wrap bare flag with adjacent")
)
assert all(ord(char) < 128 for char in rule["description"])
PY
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs-data/rpk-overrides.json` at line 341, Remove the remaining invisible
character between the opening backtick and “-f” in the description for the “Wrap
bare flag with adjacent” replacement rule, preserving the intended inline-code
example and ensuring the description contains only ASCII characters.

"pattern": "(?<![`\\w-])(-{1,2}[a-zA-Z][a-z-]*) (json/yaml|json|yaml|text|wide|csv)(?![/a-zA-Z])",
"replacement": "`$1 $2`",
"flags": "g"
Expand Down Expand Up @@ -3217,7 +3217,12 @@
"description": "Revoke every refresh token the AI gateway has issued for the named OAuth client. Forces all users who connected this client to sign in again.\n\nAlready-issued short-lived access tokens may continue working until natural expiry (typically minutes).\n\nThis command is idempotent: running it again returns 0."
},
"rpk ai oauth-client create": {
"description": "Register an OAuth client with the AI gateway. The generated client secret is printed once and cannot be retrieved afterward. Save it immediately in a secret manager."
"description": "Register an OAuth client with the AI gateway. The generated client secret is printed once and cannot be retrieved afterward. Save it immediately in a secret manager.",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai oauth-client dcr get": {
"description": "Show the Dynamic Client Registration (DCR) settings for the current tenant, including whether DCR is enabled and the configured admission mode."
Expand Down Expand Up @@ -3520,7 +3525,12 @@
"introducedInVersion": "0.2.28"
},
"rpk ai llm-provider create": {
"introducedInVersion": "0.2.28"
"introducedInVersion": "0.2.28",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai llm-provider delete": {
"introducedInVersion": "0.2.28"
Expand All @@ -3535,7 +3545,12 @@
"introducedInVersion": "0.2.28"
},
"rpk ai llm-provider update": {
"introducedInVersion": "0.2.28"
"introducedInVersion": "0.2.28",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai mcp-server": {
"introducedInVersion": "0.2.28"
Expand All @@ -3544,7 +3559,12 @@
"introducedInVersion": "0.2.28"
},
"rpk ai mcp-server create": {
"introducedInVersion": "0.2.28"
"introducedInVersion": "0.2.28",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai mcp-server delete": {
"introducedInVersion": "0.2.28"
Expand All @@ -3571,10 +3591,20 @@
"introducedInVersion": "0.2.28"
},
"rpk ai mcp-server update": {
"introducedInVersion": "0.2.28"
"introducedInVersion": "0.2.28",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai oauth-client update": {
"introducedInVersion": "0.2.28"
"introducedInVersion": "0.2.28",
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai policy": {
"introducedInVersion": "0.2.26"
Expand Down Expand Up @@ -3714,6 +3744,20 @@
},
"rpk generate license": {
"selfHostedOnly": true
},
"rpk ai oauth-provider create": {
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
},
"rpk ai oauth-provider update": {
"flags": {
"tags": {
"introducedInVersion": "0.2.33"
}
}
}
}
}
}
Loading
Loading