Skip to content

docs: improve ai-prompt-guard plugin docs#13114

Open
Yilialinn wants to merge 10 commits intomasterfrom
docs-improve-ai-prompt-guard
Open

docs: improve ai-prompt-guard plugin docs#13114
Yilialinn wants to merge 10 commits intomasterfrom
docs-improve-ai-prompt-guard

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

@Yilialinn Yilialinn commented Mar 24, 2026

Description

Improve the ai-prompt-guard plugin doc and update the Chinese version accordingly.

Which issue(s) this PR fixes:

Fixes #

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. doc Documentation things labels Mar 24, 2026
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Mar 24, 2026
@Yilialinn Yilialinn requested a review from Copilot March 24, 2026 09:43
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Yilialinn and others added 6 commits March 24, 2026 17:47
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>
@Yilialinn Yilialinn requested a review from kayx23 March 25, 2026 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants