-
Notifications
You must be signed in to change notification settings - Fork 0
GH#55: docs: add Superdav AI Agent v1.10.0 documentation #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: "Changelog" | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| # Changelog | ||
|
|
||
| ## 1.10.0 — Released on 2026-05-05 | ||
|
|
||
| ### New | ||
|
|
||
| - **Tavily internet search** — add Tavily as a search provider for richer internet search results alongside Brave Search | ||
| - **Theme-aware built-in skills** — Block Themes, Classic Themes, Kadence Blocks, and Kadence Theme skill guides now ship with the plugin | ||
| - **Site builder contact form ability** — add a contact form to any page directly from the chat interface | ||
|
|
||
| ### Improved | ||
|
|
||
| - **WooCommerce integration refactored** — now uses native WooCommerce APIs for better reliability and compatibility | ||
| - **Provider list refreshes automatically** — when any plugin is activated or deactivated | ||
|
|
||
| ### Fixed | ||
|
|
||
| - **navigate-to ability** — fixed infinite reload loop on some admin pages | ||
| - **list-posts ability** — now correctly resolves category and tag names to slugs | ||
| - **WP-CLI commands** — restored missing namespace aliases after a previous refactor | ||
| - **Event automation** — gracefully handles sites where automation tables are not yet created | ||
| - **memory-save ability** — now uses the correct namespace prefix in the system instruction builder | ||
| - **Scalar tool results** — now correctly wrapped before being returned to the AI | ||
| - **Usage statistics** — now correctly handle the legacy ability key format on upgrade from older versions |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| --- | ||
| title: "Superdav AI Agent" | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| import AddonBanner from '@site/src/components/AddonBanner'; | ||
|
|
||
| <AddonBanner slug="superdav-ai-agent" name="Superdav AI Agent" /> | ||
|
|
||
| # Superdav AI Agent | ||
|
|
||
| Superdav AI Agent is an advanced WordPress AI assistant that extends Gratis AI Agent with theme-aware skills, enhanced internet search capabilities, and improved site builder features. Version 1.10.0 adds Tavily as an alternative internet search provider, four new theme-aware built-in skills (Block Themes, Classic Themes, Kadence Blocks, and Kadence Theme), and the ability to create contact forms directly from the chat interface. | ||
|
|
||
| ## Key Features | ||
|
|
||
| - **Theme-aware skills** — automatically adapts guidance and capabilities based on your active WordPress theme and installed plugins | ||
| - **Multiple internet search providers** — choose between Brave Search and Tavily for richer search results and advanced research capabilities | ||
| - **Site builder contact forms** — create fully functional contact forms directly from the chat interface using your installed form plugin | ||
| - **Enhanced site builder** — improved multi-phase site build plans with better plugin discovery and error recovery | ||
| - **Built-in theme skills** — specialized guidance for Block Themes, Classic Themes, Kadence Blocks, and Kadence Theme | ||
| - **Improved WooCommerce integration** — refactored to use native WooCommerce APIs for better reliability and compatibility | ||
| - **Automatic provider detection** — automatically detects and refreshes available plugins and themes when they are activated or deactivated | ||
|
|
||
| ## Requirements | ||
|
|
||
| - WordPress 6.0 or higher | ||
| - PHP 8.1 or higher | ||
| - WordPress Multisite (network-activated) or single-site installation | ||
| - An active AI provider connector plugin (Anthropic, OpenAI, or compatible) | ||
| - Gratis AI Agent v1.9.0 or higher (Superdav AI Agent extends Gratis AI Agent) | ||
|
|
||
| ## Installation | ||
|
|
||
| 1. Upload the plugin files to `/wp-content/plugins/superdav-ai-agent` | ||
| 2. Activate the plugin through the **Plugins** screen in WordPress | ||
| 3. Ensure Gratis AI Agent is also activated | ||
| 4. Navigate to **Gratis AI Agent → Settings** and configure your internet search provider (optional) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| Once activated, Superdav AI Agent automatically enhances your Gratis AI Agent installation with theme-aware skills and additional capabilities. Open the **Gratis AI Agent** panel in the WordPress admin sidebar and start using the new features. | ||
|
|
||
| **Example instructions:** | ||
|
|
||
| ``` | ||
| Add a contact form to the Contact page. | ||
| ``` | ||
|
|
||
| ``` | ||
| Search the web for the latest WordPress security best practices. | ||
| ``` | ||
|
|
||
| ``` | ||
| Create a hero section using the active theme's block patterns. | ||
| ``` | ||
|
|
||
| ## Theme-Aware Skills | ||
|
|
||
| Superdav AI Agent automatically detects your active theme and installed plugins, loading the appropriate theme-aware skill into the assistant's context. Available skills include: | ||
|
|
||
| | Skill | Applies To | | ||
| |---|---| | ||
| | **Block Themes** | Themes using the WordPress block-based (Full Site Editing) architecture | | ||
| | **Classic Themes** | Traditional WordPress themes using PHP templates and the classic editor | | ||
| | **Kadence Blocks** | Sites with the Kadence Blocks plugin active | | ||
| | **Kadence Theme** | Sites with the Kadence theme as the active theme | | ||
|
|
||
| See [Theme-Aware Skills](../../user-guide/configuration/theme-aware-skills) for detailed guidance on each skill. | ||
|
|
||
| ## Internet Search Providers | ||
|
|
||
| Superdav AI Agent v1.10.0 adds **Tavily** as an alternative to Brave Search for internet search queries. Both providers offer real-time search results and can be configured in **Gratis AI Agent → Settings → Advanced**. | ||
|
|
||
| | Provider | Features | Setup | | ||
| |---|---|---| | ||
| | **Brave Search** | Fast, privacy-focused search results | [Brave Search API](https://brave.com/search/api/) | | ||
| | **Tavily** | Richer search results, advanced research capabilities | [Tavily API](https://tavily.com/) | | ||
|
|
||
| See [Internet Search](../../user-guide/configuration/internet-search) for configuration instructions. | ||
|
|
||
| ## Site Builder Contact Forms | ||
|
|
||
| The Site Builder agent can now create contact forms directly from the chat interface. Simply ask the Site Builder to create a contact form, and it will automatically detect your installed form plugin (Contact Form 7, WPForms, Fluent Forms, or Gravity Forms) and generate a ready-to-use form. | ||
|
|
||
| See [Site Builder Contact Forms](../../user-guide/administration/site-builder-contact-forms) for detailed guidance. | ||
|
|
||
| ## Configuration | ||
|
|
||
| All settings are under **Gratis AI Agent → Settings** in the WordPress admin. Superdav AI Agent adds the following configuration options: | ||
|
|
||
| | Setting | Description | | ||
| |---|---| | ||
| | **Internet Search Provider** | Choose between Brave Search and Tavily (optional) | | ||
| | **Tavily API Key** | API key for Tavily internet search (if Tavily is selected) | | ||
|
|
||
| ## Improvements in v1.10.0 | ||
|
|
||
| - **WooCommerce integration refactored** — now uses native WooCommerce APIs for better reliability and compatibility | ||
| - **Provider list auto-refresh** — automatically detects when plugins are activated or deactivated and updates the available provider list | ||
| - **Enhanced site builder** — improved multi-phase site build plans with better error recovery | ||
| - **Theme-aware skills** — four new built-in skills that automatically adapt to your active theme | ||
|
|
||
| ## Bug Fixes in v1.10.0 | ||
|
|
||
| - Fixed `navigate-to` ability causing infinite reload loops on some admin pages | ||
| - Fixed `list-posts` ability not correctly resolving category and tag names to slugs | ||
| - Fixed WP-CLI commands missing namespace aliases after a previous refactor | ||
| - Fixed event automation gracefully handling sites where automation tables are not yet created | ||
| - Fixed `memory-save` ability using the correct namespace prefix in the system instruction builder | ||
| - Fixed scalar tool results being correctly wrapped before being returned to the AI | ||
| - Fixed usage statistics correctly handling the legacy ability key format on upgrade from older versions | ||
|
|
||
| ## Support | ||
|
|
||
| For support, visit [ultimatemultisite.com](https://ultimatemultisite.com) or open an issue in the plugin repository. | ||
|
|
||
| ## Changelog | ||
|
|
||
| See the [Changelog](./changelog) for the full version history. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| title: "Site Builder Contact Forms" | ||
| sidebar_position: 22 | ||
| --- | ||
|
|
||
| # Site Builder Contact Forms | ||
|
|
||
| Superdav AI Agent v1.10.0 adds the ability to create contact forms directly from the chat interface using the Site Builder agent. This allows you to add fully functional contact forms to any page without leaving the chat. | ||
|
|
||
| ## Overview | ||
|
|
||
| The Site Builder contact form ability (`create_contact_form`) automatically detects your installed form plugin and creates a contact form using that plugin's native capabilities. Supported form plugins include: | ||
|
|
||
| - Contact Form 7 | ||
| - WPForms | ||
| - Fluent Forms | ||
| - Gravity Forms | ||
|
|
||
| The assistant automatically selects the best available form plugin on your site and generates a contact form tailored to that plugin. | ||
|
|
||
| ## Creating a Contact Form | ||
|
|
||
| To create a contact form using the Site Builder: | ||
|
|
||
| 1. Open the **Gratis AI Agent** chat panel in the WordPress admin. | ||
| 2. Switch to the **Site Builder** agent by clicking the agent icon in the chat header. | ||
| 3. Describe the contact form you want to create. For example: | ||
|
|
||
| > "Add a contact form to the Contact page with fields for name, email, message, and phone number." | ||
|
|
||
| Or simply: | ||
|
|
||
| > "Create a contact form for the Contact page." | ||
|
|
||
| 4. The Site Builder will generate the contact form and return a shortcode ready to embed. | ||
|
|
||
| ## Using the Generated Shortcode | ||
|
|
||
| After the Site Builder creates the contact form, it returns a shortcode (for example, `[contact-form-7 id="123"]`). You can: | ||
|
|
||
| 1. **Embed it in a page or post** — Copy the shortcode and paste it into any page or post using the block editor or classic editor. | ||
| 2. **Add it via the Site Builder** — Ask the Site Builder to add the form to a specific page automatically: | ||
|
|
||
| > "Add the contact form to the Contact page." | ||
|
|
||
| 3. **Use it in a template** — If you are comfortable with PHP, you can add the shortcode to a theme template file. | ||
|
|
||
| ## Customizing the Contact Form | ||
|
|
||
| After the Site Builder creates the contact form, you can customize it further: | ||
|
|
||
| ### Via the Chat Interface | ||
|
|
||
| Ask the Site Builder to modify the form: | ||
|
|
||
| > "Update the contact form to add a subject field and make the message field required." | ||
|
|
||
| The Site Builder will update the form and return the updated shortcode. | ||
|
|
||
| ### Via the Form Plugin's Admin Interface | ||
|
|
||
| You can also customize the form directly in your form plugin's settings: | ||
|
|
||
| 1. Go to **Contact Form 7** (or your installed form plugin) in the WordPress admin. | ||
| 2. Find the form created by the Site Builder. | ||
| 3. Edit the form fields, validation rules, and email notifications as needed. | ||
|
|
||
| ## Form Plugins and Compatibility | ||
|
|
||
| The Site Builder automatically detects which form plugin is installed on your site and uses it to create the contact form. If multiple form plugins are installed, the Site Builder prioritizes them in this order: | ||
|
|
||
| 1. Contact Form 7 | ||
| 2. WPForms | ||
| 3. Fluent Forms | ||
| 4. Gravity Forms | ||
|
|
||
| If none of these plugins are installed, the Site Builder will recommend installing one before creating the contact form. | ||
|
|
||
| ## Email Notifications | ||
|
|
||
| Contact forms created by the Site Builder are configured to send email notifications to the site administrator by default. You can customize the recipient email address and notification message: | ||
|
|
||
| 1. Go to your form plugin's admin interface. | ||
| 2. Find the form created by the Site Builder. | ||
| 3. Edit the email notification settings. | ||
|
|
||
| For detailed instructions, refer to your form plugin's documentation: | ||
|
|
||
| - [Contact Form 7 Email Notifications](https://contactform7.com/docs/) | ||
| - [WPForms Email Notifications](https://wpforms.com/docs/) | ||
| - [Fluent Forms Email Notifications](https://fluentforms.com/docs/) | ||
| - [Gravity Forms Email Notifications](https://docs.gravityforms.com/) | ||
|
Comment on lines
+89
to
+92
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Description: Verify external documentation links are accessible
urls=(
"https://contactform7.com/docs/"
"https://wpforms.com/docs/"
"https://fluentforms.com/docs/"
"https://docs.gravityforms.com/"
)
for url in "${urls[@]}"; do
echo "Checking: $url"
status=$(curl -s -o /dev/null -w "%{http_code}" -L "$url")
if [ "$status" -eq 200 ]; then
echo " ✓ OK (HTTP $status)"
else
echo " ✗ Failed (HTTP $status)"
fi
doneRepository: Ultimate-Multisite/docs Length of output: 301 Fix broken Contact Form 7 documentation URL. The Contact Form 7 documentation link (https://contactform7.com/docs/) returns HTTP 403 (Forbidden) and is inaccessible. Either update it to the correct URL or remove the link. The WPForms, Fluent Forms, and Gravity Forms URLs are accessible. 🤖 Prompt for AI Agents |
||
|
|
||
| ## Example Use Cases | ||
|
|
||
| ### Simple Contact Form | ||
|
|
||
| > "Create a simple contact form with name, email, and message fields." | ||
|
|
||
| ### Multi-Step Form | ||
|
|
||
| > "Create a contact form with a first step for contact information and a second step for the message and preferred contact method." | ||
|
|
||
| ### Form with Conditional Logic | ||
|
|
||
| > "Create a contact form that shows different fields based on the user's selection in a dropdown." | ||
|
|
||
| ### Form with File Upload | ||
|
|
||
| > "Create a contact form that allows users to upload a file or attachment." | ||
|
|
||
| :::note | ||
| Contact form creation is available in Superdav AI Agent v1.10.0 and later. The Site Builder agent must be active to use this ability. | ||
| ::: | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,40 +5,57 @@ sidebar_position: 26 | |
|
|
||
| # Internet Search | ||
|
|
||
| Gratis AI Agent v1.5.0 adds an **Internet Search** ability that lets the AI assistant retrieve up-to-date information from the web during a conversation. This is powered by the [Brave Search API](https://brave.com/search/api/). | ||
| Gratis AI Agent v1.5.0 adds an **Internet Search** ability that lets the AI assistant retrieve up-to-date information from the web during a conversation. This is powered by the [Brave Search API](https://brave.com/search/api/) or the [Tavily API](https://tavily.com/). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use the canonical product name consistently in user-facing text. This page mixes product names ("Gratis AI Agent" and "Superdav AI Agent"). Please standardize these references to Ultimate Multisite to match project docs conventions. Suggested text updates-Gratis AI Agent v1.5.0 adds an **Internet Search** ability that lets the AI assistant retrieve up-to-date information from the web during a conversation.
+Ultimate Multisite v1.5.0 adds an **Internet Search** ability that lets the AI assistant retrieve up-to-date information from the web during a conversation.
-Superdav AI Agent v1.10.0 adds **Tavily** as an alternative internet search provider, offering richer search results and advanced research capabilities.
+Ultimate Multisite v1.10.0 adds **Tavily** as an alternative internet search provider, offering richer search results and advanced research capabilities.
-4. Paste it into the **Tavily API Key** field in Gratis AI Agent settings.
+4. Paste it into the **Tavily API Key** field in Ultimate Multisite settings.As per coding guidelines, use "Ultimate Multisite" as the product name in all user-facing text and documentation. Also applies to: 42-42, 49-49 🤖 Prompt for AI Agents |
||
|
|
||
| ## How It Works | ||
|
|
||
| When internet search is enabled, the assistant can automatically query Brave Search when it determines that a question requires current or external information — for example, recent news, live pricing, or documentation that may have changed since the model's training cutoff. | ||
| When internet search is enabled, the assistant can automatically query your configured search provider when it determines that a question requires current or external information — for example, recent news, live pricing, or documentation that may have changed since the model's training cutoff. | ||
|
|
||
| Results are retrieved in real time and injected into the assistant's context before it generates a response. The assistant indicates when it has used search results to answer a question. | ||
|
|
||
| ## Enabling Internet Search | ||
|
|
||
| Internet search requires a Brave Search API key. To configure it: | ||
| Internet search requires an API key from your chosen search provider. To configure it: | ||
|
|
||
| 1. Go to **Gratis AI Agent → Settings → Advanced**. | ||
| 2. Locate the **Brave Search API Key** field. | ||
| 3. Enter your API key. The Brave Search API sign-up link is displayed next to the field as a clickable link. | ||
| 2. Locate the **Internet Search Provider** dropdown and select either **Brave Search** or **Tavily**. | ||
| 3. Enter your API key in the corresponding field. Sign-up links are displayed next to each field. | ||
| 4. Click **Save Settings**. | ||
|
|
||
| Once the key is saved, the Internet Search ability is automatically available to the assistant. | ||
|
|
||
| ## Obtaining a Brave Search API Key | ||
| ## Brave Search | ||
|
|
||
| 1. Visit the [Brave Search API page](https://brave.com/search/api/) (link also shown in the settings field). | ||
| ### Obtaining a Brave Search API Key | ||
|
|
||
| 1. Visit the [Brave Search API page](https://brave.com/search/api/). | ||
| 2. Sign up for a plan. A free tier is available with a monthly request limit. | ||
| 3. Copy your API key from the Brave Search developer dashboard. | ||
| 4. Paste it into the **Brave Search API Key** field in Gratis AI Agent settings. | ||
|
|
||
| ### Usage Limits | ||
|
|
||
| Usage is billed by Brave Search based on the number of queries made. Each AI response that triggers a search counts as one query. Monitor your usage in the [Brave Search developer dashboard](https://brave.com/search/api/) to avoid unexpected charges. | ||
|
|
||
| ## Tavily | ||
|
|
||
| Superdav AI Agent v1.10.0 adds **Tavily** as an alternative internet search provider, offering richer search results and advanced research capabilities. | ||
|
|
||
| ### Obtaining a Tavily API Key | ||
|
|
||
| 1. Visit the [Tavily API page](https://tavily.com/). | ||
| 2. Sign up for an account. A free tier is available with a monthly request limit. | ||
| 3. Copy your API key from the Tavily dashboard. | ||
| 4. Paste it into the **Tavily API Key** field in Gratis AI Agent settings. | ||
|
|
||
| ### Usage Limits | ||
|
|
||
| Usage is billed by Tavily based on the number of API calls made. Each AI response that triggers a search counts as one call. Monitor your usage in the [Tavily dashboard](https://tavily.com/) to avoid unexpected charges. | ||
|
|
||
| ## Disabling Internet Search | ||
|
|
||
| Remove the API key from the **Brave Search API Key** field and save. The Internet Search ability will no longer be offered to the assistant. | ||
| Remove the API key from the active search provider field and save. The Internet Search ability will no longer be offered to the assistant. | ||
|
|
||
| :::note | ||
| Internet search adds latency to responses because the assistant must wait for search results before generating an answer. For time-sensitive use cases, consider whether real-time search is necessary or whether the assistant's built-in knowledge is sufficient. | ||
| ::: | ||
|
|
||
| ## Usage Limits | ||
|
|
||
| Usage is billed by Brave Search based on the number of queries made. Each AI response that triggers a search counts as one query. Monitor your usage in the [Brave Search developer dashboard](https://brave.com/search/api/) to avoid unexpected charges. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use "Ultimate Multisite" as the product name.
This line references "Gratis AI Agent" but the coding guidelines require using "Ultimate Multisite" as the product name in all user-facing documentation. As per coding guidelines, "Use 'Ultimate Multisite' as the product name in all user-facing text and documentation."
📝 Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents