Skip to content

Add AI Connector and AI Analysis setup documentation - #1395

Merged
davidperezgar merged 1 commit into
WordPress:trunkfrom
NoumaanAhamed:docs/1387-ai-features-documentation
Jul 14, 2026
Merged

davidperezgar merged 1 commit into
WordPress:trunkfrom
NoumaanAhamed:docs/1387-ai-features-documentation

Conversation

@NoumaanAhamed

@NoumaanAhamed NoumaanAhamed commented Jul 14, 2026 •

Copy link
Copy Markdown
Contributor

What?

Closes #1387

Adds comprehensive documentation for Plugin Check's AI-powered features covering setup, configuration, model selection, and troubleshooting. Also documents the --ai and --ai-model CLI flags.

Why?

Plugin Check includes AI features (false-positive detection, Namer tool, severity thresholds) but had no documentation explaining how to configure or use them. Developers had no guidance on required setup or expected behavior.

How?

  • [NEW] docs/ai-features.md — Covers prerequisites, connector setup, model selection, AI analysis behavior, severity thresholds, privacy guarantees, graceful degradation, troubleshooting, and limitations.
  • [MODIFIED] docs/CLI.md — Documents --ai and --ai-model flags with examples.
  • [MODIFIED] docs/README.md — Links to the new AI features doc.

Testing Instructions

  1. Open docs/ai-features.md and verify it covers all topics listed in Add AI Connector and AI Analysis setup documentation for Plugin Check #1387.
  2. Verify docs/CLI.md includes --ai and --ai-model flag documentation under wp plugin check.
  3. Verify docs/README.md links to ai-features.md.

AI Usage Disclosure

  • This PR was created without the help of AI tools
  • This PR includes AI-assisted code or content

If AI tools were used, please describe how they were used:
Used Claude to draft and refine the documentation content based on the existing codebase.

Screenshots or screencast

N/A — documentation only.

Open WordPress Playground Preview

@github-actions

Copy link
Copy Markdown
Contributor

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: NoumaanAhamed <mohamedahamed@git.wordpress.org>
Co-authored-by: tushar-addweb <tusharaddweb@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@davidperezgar
davidperezgar merged commit a3a22f3 into WordPress:trunk Jul 14, 2026
5 checks passed
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.

Add AI Connector and AI Analysis setup documentation for Plugin Check

3 participants