WordPress.org
Get WordPress

Plugin Directory

Changeset 3412526


Ignore:
Timestamp:
12/05/2025 07:20:20 PM (6 weeks ago)
Author:
JeffPaul
Message:

update readme with WPORG plugin page content

File:
1 edited

Legend:

Unmodified
Added
Removed

  • ai/trunk/readme.txt

    r3407614 r3412526  
    1111== Description ==
    1212
    13 AI Experiments is a plugin for testing and developing AI-powered experiments for WordPress. This plugin provides a framework for building, testing, and deploying experimental AI capabilities.
     13The WordPress AI Experiments plugin brings experimental AI-powered features directly into your WordPress admin and editing experience.
     14
     15**What's Inside:**
     16
     17This plugin is built on the [AI Building Blocks for WordPress](https://make.wordpress.org/ai/2025/07/17/ai-building-blocks) initiative, combining the WP AI Client SDK, Abilities API, and MCP Adapter into a unified experience. It serves as both a practical tool for content creators and a reference implementation for developers.
     18
     19**Current Features:**
     20
     21* **Title Generation** - Generate title suggestions for your posts with a single click. Perfect for brainstorming headlines or finding the right tone for your content.
     22* **Experiment Framework** - Opt-in system that lets you enable only the AI features you want to use.
     23* **Multi-Provider Support** - Works with popular AI providers like OpenAI, Google, and Anthropic.
     24
     25**Coming Soon:**
     26
     27We're actively developing new features to enhance your WordPress workflow:
     28
     29* **Excerpt Generation** - Automatically create concise summaries for your posts
     30* **Image Generation** - Create images from text prompts directly in the block editor
     31* **Alt Text Generation** - Generate descriptive alt text for images to improve accessibility
     32* **Content Summarization** - Quickly summarize long-form content
     33* **Contextual Tagging** - AI-suggested tags and categories to organize your content
     34* **AI Playground** - Experiment with different AI models and prompts
     35
     36This is an experimental plugin; functionality may change as we gather feedback from the community.
    1437
    1538== Installation ==
    … …  
    21445. Start experimenting with AI features! For the Title Generation experiment, edit a post and click into the title field. You should see a `Generate/Re-generate` button above the field. Click that button and after the request is complete, title suggestions will be displayed in a modal. Choose the title you like and click the `Select` button to insert it into the title field.
    2245
     46== For Developers ==
     47
     48The AI Experiments plugin is designed to be studied, extended, and built upon. Whether you're a plugin developer, agency, or hosting provider, here's what you can do:
     49
     50**Extend the Plugin:**
     51
     52* **Build Custom Experiments** - Use the `Abstract_Experiment` base class to create your own AI-powered features
     53* **Register Custom Abilities** - Hook into the Abilities API to add new AI capabilities
     54* **Override Default Behavior** - Use filters to customize prompts, responses, and UI elements
     55* **Pre-configure Providers** - Hosts and agencies can set up AI providers so users don't need their own API keys
     56
     57**Developer Tools Coming Soon:**
     58
     59* **Abilities Explorer** - Test and explore registered AI abilities (available when experiments are enabled)
     60* **MCP Demo** - See how Model Context Protocol integration works with WordPress
     61* **Comprehensive Hooks** - Filters and actions throughout the codebase for customization
     62
     63
     64**Get Started:**
     65
     661. Read the [Contributing Guide](https://github.com/WordPress/ai/blob/trunk/CONTRIBUTING.md) for development setup
     672. Join the conversation in [#core-ai on WordPress Slack](https://wordpress.slack.com/archives/C08TJ8BPULS)
     683. Browse the [GitHub repository](https://github.com/WordPress/ai) to see how experiments are built
     694. Participate in [discussions](https://github.com/WordPress/ai/discussions) on how best the plugin should iterate.
     70
     71We welcome contributions! Whether you want to build new experiments, improve existing features, or help with documentation, check out our [GitHub repository](https://github.com/WordPress/ai) to get involved.
     72
    2373== Frequently Asked Questions ==
    2474
    2575= What is this plugin for? =
    2676
    27 This plugin is for experimenting with AI features in WordPress. It provides a framework for building and testing AI-powered capabilities.
     77This plugin brings AI-powered writing and editing tools directly into WordPress. It's also a reference implementation for developers who want to build their own AI features.
    2878
    29 = Is this production-ready? =
     79= Is this safe to use on a production site? =
    3080
    31 No, this is an experimental plugin for testing and development purposes.
     81This is an experimental plugin, so we recommend testing in a staging environment first. Features may change as we gather community feedback. All AI features are opt-in and require manual triggering - nothing happens automatically without your approval.
     82
     83= Which AI providers are supported? =
     84
     85The plugin supports OpenAI, Google AI (Gemini), and Anthropic (Claude). You can configure one or multiple providers in Settings -> AI Credentials.
     86
     87= Do I need an API key to use the experiments? =
     88
     89Yes, currently you need to provide your own API key from a supported AI provider (OpenAI, Google AI, or Anthropic).
     90
     91= How much does it cost? =
     92
     93The plugin itself is free, but you'll need to pay for API usage from your chosen AI provider. Costs vary by provider and usage. Most providers offer free trial credits to get started.
     94
     95= Can I use this without coding knowledge? =
     96
     97Absolutely! The plugin is designed for content creators and site administrators. Once your API credentials are configured, you can use AI experiments directly from the post editor.
     98
     99= Where can I get help or report issues? =
     100
     101You can ask questions in the [#core-ai channel on WordPress Slack](https://wordpress.slack.com/archives/C08TJ8BPULS) or report issues on the [GitHub repository](https://github.com/WordPress/ai/issues).
    32102
    33103== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.