docs: improve ai-prompt-guard plugin docs#13114
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refreshes the ai-prompt-guard plugin documentation (English + Chinese) to better explain allow/deny behavior and to provide fuller, multi-environment configuration examples for using it alongside ai-proxy.
Changes:
- Expanded the plugin description and clarified allow/deny evaluation behavior.
- Added canonical link metadata and significantly expanded example sections (Admin API, ADC, and Ingress Controller variants).
- Updated the Chinese documentation to match the English structure and content.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 16 comments.
| File | Description |
|---|---|
| docs/en/latest/plugins/ai-prompt-guard.md | Adds canonical metadata, rewrites description/attributes, and adds detailed usage examples across deployment methods. |
| docs/zh/latest/plugins/ai-prompt-guard.md | Mirrors the English doc improvements and adds the same expanded examples and clarifications in Chinese. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Improve the ai-prompt-guard plugin doc and update the Chinese version accordingly.
Which issue(s) this PR fixes:
Fixes #
Checklist