Initial commit

2025-12-11 14:43:16 +01:00
commit 7ef62972f3
36 changed files with 23641 additions and 0 deletions
--- a/docs/Integrations/WordPress/WordPress
+++ b/docs/Integrations/WordPress/WordPress
@@ -0,0 +1,96 @@
+---
+id: wordpress-overview
+title: WordPress Integration
+description: Overview of Evie's WordPress integration capabilities
+sidebar_label: Overview
+sidebar_position: 1
+---
+
+# WordPress Integration
+
+Evie offers seamless integration with WordPress through two dedicated plugins that help you enhance your WordPress site with AI capabilities. These plugins allow you to both synchronize your content with Evie's knowledge base and provide intelligent chat functionality to your visitors.
+
+## Available Plugins
+
+### Content Synchronization (eveai_sync)
+The content synchronization plugin automatically keeps your Evie knowledge base up-to-date with your WordPress content:
+- Syncs posts and pages to Evie's Standard Catalog
+- Maintains versioning of your content
+- Ensures your AI interactions always use the latest content
+
+### Chat Integration (eveai_chat)
+Add intelligent chat capabilities to your WordPress site:
+- Easy-to-integrate chat widget
+- Powered by Evie's Q&A RAG Specialist
+- Supports multiple languages
+- Simple configuration and setup
+
+## Prerequisites
+
+Before you can use either plugin, you'll need:
+
+1. A WordPress website
+2. An Evie account with API access
+3. An API key from Ask Eve AI
+
+## Getting Started
+
+### Obtaining Your API Key
+
+To use the WordPress plugins, you'll need an API key from Ask Eve AI. You can ask your AskEveAI administrator to provide you
+with an API Key. After the request, you'll receive an email containing:
+- Your tenant information
+- A unique API key
+- Enabled services information
+
+Here's an example of the API key email you'll receive:
+
+![API Key Email Example](/img/wordpress-api-email.png)
+
+:::important
+Store your API key securely. It cannot be retrieved once the email is gone.
+:::
+
+```mermaid
+flowchart LR
+    A[Request API Access] -->|Receive Email| B[API Key]
+    B --> C[Configure Plugins]
+    C --> D[Start Using Integration]
+```
+
+### Installation
+
+Both plugins can be [downloaded here](https://www.dropbox.com/scl/fo/6pkrp8o1n6rjvawjyrstt/AGGNOGlVn4hAz_BZOngOj68?rlkey=nj9gyz1k0bcjz7sxr0jq5c59l&dl=0)
+
+Both plugins follow the standard WordPress plugin installation process:
+
+1. Download the plugin files
+2. Go to your WordPress admin panel
+3. Navigate to Plugins > Add New
+4. Click "Upload Plugin"
+5. Select the plugin file and click "Install Now"
+6. Activate the plugin
+
+### Next Steps
+
+After installation, each plugin requires specific configuration:
+
+- [Content Synchronization Setup](./sync-plugin) - Configure how your WordPress content syncs with Evie
+- [Chat Integration Setup](./chat-plugin) - Set up the AI chat widget for your website
+
+## Support and Customization
+
+:::important
+Aggressive caching in WordPress can cripple correct behaviour of the Chat Plugin
+:::
+
+When running into problems:
+- Enable debugging in WordPress. We have quite extensive logging in both components.
+- For the chatbot itself, you can check the browser console (at least, on Chrome). A lot of debugging information is available.
+
+Both plugins are provided as open-source software, allowing for:
+- Custom modifications to match your needs
+- Integration with existing WordPress themes
+- Extended functionality development
+
+For technical support or questions about customization, please contact our support team.