Update documentation for Redis Queue v2.0.0 breaking changes

[Copilot]

Overview

This PR updates all documentation to reflect the breaking changes in Redis Queue version 2.0.0, where the plugin was renamed from "Redis Queue Demo" to "Redis Queue" and the namespace was changed from Soderlind\RedisQueueDemo to Soderlind\RedisQueue.

Changes Made

CHANGELOG.md

• Added comprehensive 2.0.0 entry documenting all breaking changes
• Included detailed migration guide with before/after code examples:
  • Namespace import updates
  • Function call changes
  • Filter/action hook updates
• Documented automatic options migration from redis_queue_demo_* to redis_queue_*

README.md

• Updated title from "Redis Queue Demo for WordPress" to "Redis Queue for WordPress"
• Repositioned from "demo/inspiration" to "production-ready queue system"
• Updated all GitHub URLs from redis-queue-demo to redis-queue
• Updated download file name from redis-queue-demo.zip to redis-queue.zip
• Changed all function calls from redis_queue_demo() to redis_queue()
• Updated filter name from redis_queue_demo_create_job to redis_queue_create_job
• Updated namespace in code examples from Soderlind\RedisQueueDemo to Soderlind\RedisQueue
• Removed entire "Namespacing & Backward Compatibility (Refactor Notes)" section as it no longer applies

readme.txt (WordPress.org)

• Changed plugin name to "Redis Queue"
• Updated stable tag to 2.0.0
• Added comprehensive 2.0.0 changelog entry listing all breaking changes
• Added prominent upgrade notice warning users about the breaking nature of this release
• Updated all URLs and directory references

Documentation Files (docs/*.md)

Updated all documentation files to use new naming conventions:

• docs/README.md: Updated plugin name
• docs/usage.md: Updated namespace imports and function calls
• docs/extending-jobs.md: Updated namespace, filter names, and code examples
• docs/worker-rest-api.md: Updated all filter names (redis_queue_demo_* → redis_queue_*)
• docs/maintenance.md: Updated action names
• docs/scaling.md: Updated plugin name

Breaking Changes Documented

1. Plugin Name: "Redis Queue Demo" → "Redis Queue"
2. Namespace: Soderlind\RedisQueueDemo → Soderlind\RedisQueue
3. Main Function: redis_queue_demo() → redis_queue()
4. Filter/Action Prefix: redis_queue_demo_* → redis_queue_*
5. Text Domain: redis-queue-demo → redis-queue
6. Repository URLs: Updated from redis-queue-demo to redis-queue
7. Composer Package: Will be soderlind/redis-queue
8. No Backward Compatibility: All legacy aliases removed

Migration Example

The CHANGELOG now provides clear migration examples for developers:

// Old (1.x)
use Soderlind\RedisQueueDemo\Core\Redis_Queue_Manager;
$queue = redis_queue_demo();
add_filter('redis_queue_demo_create_job', ...);

// New (2.0.0)
use Soderlind\RedisQueue\Core\Redis_Queue_Manager;
$queue = redis_queue();
add_filter('redis_queue_create_job', ...);

Files Changed

• CHANGELOG.md
• README.md
• readme.txt
• docs/README.md
• docs/usage.md
• docs/extending-jobs.md
• docs/worker-rest-api.md
• docs/maintenance.md
• docs/scaling.md

Total: 9 files, 99 insertions(+), 102 deletions(-)

Notes

• REST API namespace remains redis-queue/v1 for API stability
• One-time automatic migration handles renaming of WordPress options
• All code examples updated to demonstrate new conventions

Original prompt

Update documentation: README, docs/*.md, CHANGELOG entry for 2.0.0 (breaking changes).

Summary of Conversation History

User Goals

The user is working on a WordPress plugin named "Redis Queue Demo," which they want to rename to "Redis Queue." They are focused on updating the plugin's namespace, classes, methods, documentation, and versioning, specifically to version 2.0.0. The user has also expressed a desire to remove backward compatibility and to clean up the codebase by removing old paths and files.

Recent Agent Commands and Tool Results

1. User Request: "Rename plugin from Redis Queue Demo to Redis Queue. - namespace, classes, methods etc - docs (*.md, readme.txt)"

   • The user requested a comprehensive renaming of the plugin, including all relevant namespaces, classes, methods, and documentation files.

2. User Request: "continue with all files"

   • The user asked the agent to continue processing all files related to the plugin to ensure the renaming and updates are applied consistently.

3. User Request: "Update documentation: README, docs/*.md, CHANGELOG entry for 2.0.0 (breaking changes)."

   • The user requested updates to the documentation, specifically the README file, markdown files in the docs directory, and the CHANGELOG to reflect the breaking changes associated with the new version.

Active Work When Token Budget Exceeded

The agent was actively working on updating the documentation and renaming the plugin when the token budget was exceeded. The focus was on ensuring that all references to the old plugin name and structure were replaced with the new naming conventions.

Connection to Overall User Goals

These recent operations are directly aligned with the user's goal of transitioning the plugin to a new version (2.0.0) with a new name and structure. The user is aiming for a clean codebase without legacy references, which is essential for maintaining clarity and functionality in the plugin's future development. The emphasis on documentation updates also highlights the user's intent to provide clear guidance for users and developers interacting with the plugin.
TITLE: Updating documentation for Redis Queue plugin version 2.0.0

Created from VS Code via the GitHub Pull Request extension.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.