Skip to content

Improve OneSearch readme.txt for WordPress plugin release #129

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.

Sign up for GitHub

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

Merged
up1512001 merged 2 commits into from
Jan 28, 2026
Merged

Improve OneSearch readme.txt for WordPress plugin release #129

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12f7e78
Improve OneSearch readme.txt for WordPress plugin release
SalmanRavoof Jan 28, 2026
7bc93cd
Addressed @justlevine's comments
SalmanRavoof Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 67 additions & 5 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==

Expand All @@ -39,13 +93,21 @@ 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 <a href="https://github.com/rtCamp/OneLogs/blob/main/CHANGELOG.md" target="_blank">GitHub repository</a>.
See <a href="https://github.com/rtCamp/OneSearch/blob/main/CHANGELOG.md" target="_blank">CHANGELOG.md</a> for detailed changelog.

== Support ==

Expand Down
Loading