From 12f7e78462407b8611ae35d1ef3504d38b482d2a Mon Sep 17 00:00:00 2001 From: Salman Ravoof Date: Tue, 27 Jan 2026 18:13:11 -0600 Subject: [PATCH 1/2] Improve OneSearch readme.txt for WordPress plugin release Aligns readme.txt with GitHub README documentation and OneAccess template structure. Changes: - Short description (was missing, added it): "Cross-site, brand-aware search across multi-brand WordPress networks, powered by Algolia." - Description: Added "Why OneSearch?", "Key Benefits" (6), "Core Features" (6), and "Perfect for" (5 use cases) sections - Installation: Expanded from 3 to 5 steps. Added "Setting up Algolia" and "Configuring Indices and Search Scope" subsections - FAQs: Added 2 new questions about Algolia account and search scope control - Screenshots: Added note that screenshots need to be captured before release - Changelog: Fixed incorrect URL (was pointing to OneLogs repo). Expanded 1.0.0 entry with 8 feature bullet points - New sections: Upgrade Notice, Requirements All content sourced from GitHub README to ensure accuracy. --- readme.txt | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 88 insertions(+), 5 deletions(-) diff --git a/readme.txt b/readme.txt index fe890b7..66e36ae 100644 --- a/readme.txt +++ b/readme.txt @@ -9,17 +9,71 @@ Requires PHP: 8.0 License: GPLv2 or later License URI: https://www.gnu.org/licenses/gpl-2.0.html +Cross-site, brand-aware search across multi-brand WordPress networks, powered by Algolia. + == Description == OneSearch is part of the OnePress ecosystem, designed to enable cross-site search across multi-brand WordPress networks. It centralizes the discovery process, allowing users to search and retrieve relevant content from multiple connected sites from whichever site(s) in your brand network you choose to make searchable. This plugin acts as the backend engine that powers the indexing, querying, brand network management, and filtering logic needed for federated search. +**Why OneSearch?** + +Managing content across multiple brands, regions, or business units often results in disconnected search experiences. This can lead to broken user journeys and lost discovery opportunities. + +OneSearch solves this by enabling a federated search layer that bridges multiple sites, powered by Algolia, delivering a consistent and brand-respecting experience across the network. + +**Key Benefits:** + +* **Unified Search Layer:** Execute a single search query across multiple connected sites +* **Brand Awareness:** Show source brand site and redirect users to the respective site +* **Governance & Control:** Control visibility and indexing scope at the site or post-type level +* **Developer Extensibility:** Easily register post types, taxonomies, and metadata for indexing +* **Performance Optimized:** Lightweight REST architecture with cache-friendly responses +* **Modular Design:** Extend and customize indexing and search behavior without core overrides + +**Core Features:** + +* **Cross-Site (Federated) Search:** Aggregate search results across multisite or standalone installations +* **Configurable Indexing:** Register which post types, taxonomies, or meta fields are searchable on a per-site basis +* **Custom Blocks:** Gutenberg-ready blocks for search interfaces +* **Bring Your Own Key:** Connect with your Algolia instance for improved data sovereignty and reduced vendor lock-in +* **Automatic Indexing:** Posts are automatically indexed on publish and removed on deletion +* **Local Content Boost:** Search results prioritize content from the current site while including network-wide results + +**Perfect for:** + +* Enterprise WordPress deployments with multiple brand sites +* Organizations requiring unified content discovery across sites +* Companies with multi-region or multi-brand content strategies +* Agencies managing multiple client sites with shared content +* Media networks needing cross-publication search capabilities + == Installation == -1. Download the latest OneSearch plugin from the GitHub releases and install it on your WordPress sites. -2. Activate the plugin. For multisite installations, make sure to Network Activate the plugin. -3. Visit the Dashboard > OneSearch > Settings page to configure the Governing and Brand sites. +1. Download the latest OneSearch plugin from the GitHub releases and install it on your WordPress sites +2. Activate the plugin through the 'Plugins' screen in WordPress + * For multisite installations, make sure to Network Activate the plugin +3. **Choose Site Type (One-time selection):** + * **Governing Site:** Central site that manages the brand network and search configurations (one per network) + * **Brand Site:** Individual sites connected to the governing site for cross-site search +4. **For Brand Sites:** Navigate to Dashboard → OneSearch → Settings to get the API key +5. **For Governing Site:** Go to Dashboard → OneSearch → Settings and add Brand Sites by entering Site name, URL, and the API Key obtained from each Brand Site + +**Setting up Algolia:** + +1. Visit Algolia (https://www.algolia.com/) and create an account if you don't have one +2. Go to your API Keys dashboard in Algolia +3. Copy the Application ID and Write API Key +4. Paste both keys into Dashboard → OneSearch → Settings under the 'Algolia Credentials' section + +**Configuring Indices and Search Scope:** + +1. Navigate to OneSearch → Indices and Search on the Governing Site +2. For each connected site, choose which post types to index +3. Click 'Save' to save settings and index the data +4. In the 'Site Search Configuration' section, enable OneSearch on desired sites +5. Configure which sites can be searched from each enabled site == Frequently Asked Questions == @@ -39,13 +93,42 @@ Yes. Any updates made to a post are automatically synced with the Algolia index. Search results are ranked by Algolia's relevance algorithm. However, OneSearch boosts results from the current site you're searching on, ensuring more relevant local content appears first. You can further customize ranking and relevance through Algolia's dashboard. += Do I need my own Algolia account? = + +Yes. OneSearch uses a "Bring Your Own Key" approach, connecting to your Algolia instance for improved data sovereignty and reduced vendor lock-in. + += Can I control which sites are searchable from each brand site? = + +Yes. From the Governing Site, you can configure the search scope for each brand site, controlling which sites' content appears in search results. + == Screenshots == -@todo +@todo - Screenshots need to be captured and added before release. == Changelog == -For the full changelog, please visit GitHub repository. +See CHANGELOG.md for detailed changelog. + += 1.0.0 = +* Initial public release of OneSearch +* Cross-site federated search powered by Algolia +* Configurable indexing by post type per site +* Automatic indexing on publish, update, and deletion +* Local content boost in search results +* Gutenberg-ready search blocks +* Brand site connection and API key management +* Search scope configuration per site + +== Upgrade Notice == + += 1.0.0 = +Initial release of OneSearch. Perfect for enterprises requiring unified content discovery across multiple WordPress sites with Algolia-powered federated search. + +== Requirements == + +* WordPress 6.8 or higher +* PHP 8.0 or higher +* Algolia account with Application ID and Write API Key == Support == From 7bc93cd3093f60e7138b7774941b1179a809ddc6 Mon Sep 17 00:00:00 2001 From: Salman Ravoof Date: Wed, 28 Jan 2026 03:24:48 -0600 Subject: [PATCH 2/2] Addressed @justlevine's comments Changes: - Changelog section now only links to the Changelog. - Removed Upgrade Notice and Requirements sections. --- readme.txt | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/readme.txt b/readme.txt index 66e36ae..53c5664 100644 --- a/readme.txt +++ b/readme.txt @@ -109,27 +109,6 @@ Yes. From the Governing Site, you can configure the search scope for each brand See CHANGELOG.md for detailed changelog. -= 1.0.0 = -* Initial public release of OneSearch -* Cross-site federated search powered by Algolia -* Configurable indexing by post type per site -* Automatic indexing on publish, update, and deletion -* Local content boost in search results -* Gutenberg-ready search blocks -* Brand site connection and API key management -* Search scope configuration per site - -== Upgrade Notice == - -= 1.0.0 = -Initial release of OneSearch. Perfect for enterprises requiring unified content discovery across multiple WordPress sites with Algolia-powered federated search. - -== Requirements == - -* WordPress 6.8 or higher -* PHP 8.0 or higher -* Algolia account with Application ID and Write API Key - == Support == For support, feature requests, and bug reports, please visit our [GitHub repository](https://github.com/rtCamp/OneSearch).