Skip to content

Improve OneSearch readme.txt for WordPress plugin release#129

Merged
up1512001 merged 2 commits intortCamp:developfrom
SalmanRavoof:patch-1
Jan 28, 2026
Merged

Improve OneSearch readme.txt for WordPress plugin release#129
up1512001 merged 2 commits intortCamp:developfrom
SalmanRavoof:patch-1

Conversation

@SalmanRavoof
Copy link
Contributor

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.

Description

Technical Details

Checklist

Screenshots

To-do

Fixes/Covers issue

Fixes #

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.
Copy link
Collaborator

@justlevine justlevine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM, but as noted my eyes are shot so @up1512001 deferring to you.

Changes:
- Changelog section now only links to the Changelog. 
- Removed Upgrade Notice and Requirements sections.
Copy link
Member

@up1512001 up1512001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@up1512001 up1512001 merged commit 52b0717 into rtCamp:develop Jan 28, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants