Add comprehensive context to WPORG readme#135
Conversation
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @mohamed.khaled@9hdigital.com. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #135 +/- ##
=============================================
- Coverage 44.42% 38.91% -5.52%
- Complexity 111 176 +65
=============================================
Files 13 16 +3
Lines 610 1010 +400
=============================================
+ Hits 271 393 +122
- Misses 339 617 +278
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
readme.txt
Outdated
| This plugin is for experimenting with AI features in WordPress. It provides a framework for building and testing AI-powered capabilities. | ||
| This 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. | ||
|
|
||
| = Do I need my own API key? = |
There was a problem hiding this comment.
Assumedly this applies to specific experiments. Experiments that target the Abilities API like the explorer don't require any LLMs to work, and my gut says we're more likely to see e.g. free-browser models come as an experiment than straight into the settings panel.
(This is exacerbated by "API key" being contextually ambiguous, and made a larger nit because it's basically the same content as the next FAQ item)
There was a problem hiding this comment.
Maybe rephrase to something like "What do I need to use this plugin?" or similar? API key being one thing, when an experiment requires one, and other things like WP 6.9+, etc.
|
|
||
| = How much does it cost? = | ||
|
|
||
| The 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. |
There was a problem hiding this comment.
This too should be experiment scoped.
readme.txt
Outdated
| **Get Started:** | ||
|
|
||
| 1. Read the [Contributing Guide](https://github.com/WordPress/ai/blob/trunk/CONTRIBUTING.md) for development setup | ||
| 2. Join the discussion in [#core-ai on WordPress Slack](https://wordpress.slack.com/archives/C08TJ8BPULS) |
There was a problem hiding this comment.
Could also link to GitHub discussions here: https://github.com/WordPress/ai/discussions
readme.txt
Outdated
| This plugin is for experimenting with AI features in WordPress. It provides a framework for building and testing AI-powered capabilities. | ||
| This 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. | ||
|
|
||
| = Do I need my own API key? = |
There was a problem hiding this comment.
Maybe rephrase to something like "What do I need to use this plugin?" or similar? API key being one thing, when an experiment requires one, and other things like WP 6.9+, etc.
readme.txt
Outdated
|
|
||
| = Do I need my own API key? = | ||
|
|
||
| Yes, currently you need to provide your own API key from a supported AI provider (OpenAI, Google AI, or Anthropic). Future versions may allow hosting providers to pre-configure this for you. |
There was a problem hiding this comment.
| Yes, currently you need to provide your own API key from a supported AI provider (OpenAI, Google AI, or Anthropic). Future versions may allow hosting providers to pre-configure this for you. | |
| Yes, currently you need to provide your own API key from a supported AI provider (OpenAI, Google, or Anthropic). Future versions may allow for browser-based and local-hosted models or for hosting providers to pre-configure this for you. |
jeffpaul
added
the
props-bot
github-actions
bot
removed
the
props-bot
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
Co-authored-by: John Parris <public@johnparris.com>
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
Co-authored-by: Jeffrey Paul <jeffpaul@hotmail.com>
jeffpaul
added
the
props-bot
github-actions
bot
removed
the
props-bot
4 participants
Enhances readme.txt with detailed context for non-technical users and developers.
Changes:
Fixes #133