Skip to content

docs: rename project to Plexus and rewrite README#6

Merged
otabek05 merged 1 commit into
mainfrom
docs/rename-to-plexus
May 11, 2026
Merged

docs: rename project to Plexus and rewrite README#6
otabek05 merged 1 commit into
mainfrom
docs/rename-to-plexus

Conversation

@Sardor-M
Copy link
Copy Markdown

@Sardor-M Sardor-M commented May 8, 2026

Summary

Rename the project from CoreMQ to Plexus and rewrite the README around the new identity.

Plexus — anatomical term for a network of nerves (e.g. solar plexus, brachial plexus). Direct metaphor for what an MQTT broker does: act as the central junction that every signal routes through. Distinctive in the MQTT/messaging space, no major collisions, technical without being pretentious.

This PR is README-only. The Cargo crate (coremq-server), the npm package (coremq-dashboard), the config paths (/etc/coremq/), and the GitHub repo name are unchanged. A follow-up PR will handle the rename across code/config — kept separate so the rebrand decision can be reviewed independently of the mechanical renames.

Why a separate name

CoreMQ is technically accurate but generic — core + MQ reads as a placeholder. Five other projects use core in their messaging product name. Plexus is:

  • Descriptive of function. A plexus is literally a routing network. The broker's job is routing; the name tells you what it does.
  • Single-word. No MQ suffix needed — the architecture-as-name does the work.
  • Distinctive. Not used in the MQTT/messaging space. Searchable.
  • Technical, not marketing. Reads like infrastructure, not a startup landing page.

What's in the rewrite

Diff: +146 / −211 (357 → 305 lines, ~28% shorter, denser).

  • New tagline. Opening paragraph explains the architectural choice behind the name (one Tokio engine, async channels, single-threaded event loop).
  • Lead with At a glance — seven bullets covering the whole feature surface in 10 seconds.
  • Merge the redundant MQTT Protocol Support + Multi-Transport Support sections — they were saying the same thing twice.
  • Architecture: same diagram, but the prose now explains why the single-threaded engine matters (no long-held locks, no contention, easy to reason about) instead of just describing it.
  • Performance and Security are paragraphs, not bullet lists. Drop marketing-speak ("zero-cost abstractions", "designed for IoT-scale workloads") that doesn't carry information.
  • Topic Monitoring & REST Publish: kept the why-it-matters list and the curl examples; dropped the long JSON sample (callers can read the spec).
  • QoS claims rewritten to match reality. Was: "QoS 0 (expandable to QoS 1/2)". Now: "QoS 0 in production, QoS 1/2 wiring in progress." This matches what's actually shipped — the recent packet_id panic fix (docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5ef67625) is part of the QoS 1/2 path, not full support.
  • Roadmap: drop "WebSocket metrics endpoint" — already shipped and documented above (was a copy-paste from a stale roadmap).
  • New Contributing section linking CONTRIBUTING.md, AGENTS.md, CHANGELOG.md. Note: those three files are added in docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5 — links resolve once both this PR and docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5 are on main.
  • Honest callout that "Plexus" branding is ahead of the package rename, so readers don't get confused by coremq-server in the build commands.

Follow-up renames (separate PRs)

If the name lands well, the deferred mechanical changes are:

  1. server/coremq-server/Cargo.tomlname = "plexus-server" (or "plexus"), update workspace members, fix cargo run -p invocations across docs.
  2. client/package.json"name": "plexus-dashboard".
  3. Config paths: /etc/coremq//etc/plexus/, C:\ProgramData\CoreMQ\C:\ProgramData\Plexus\. Migration shim or doc on how to move existing config.
  4. Repo rename: mqttRust/coremq_rustmqttRust/plexus. GitHub redirects from the old name.
  5. Docker image name + docker-compose service name.

Each of these is independently reversible. None block this PR.

Test plan

  • Read the new README top to bottom, look for stale CoreMQ references or broken links.
  • Verify the architecture diagram still renders properly in GitHub's markdown preview.
  • Confirm make build / docker compose up -d flows still work — README doesn't change them.
  • If you'd rather the name be different, comment with the alternative; this PR is cheap to retitle.

Notes

Rebrand CoreMQ as Plexus — anatomical metaphor for a network of
nerves, mapping directly to the broker's role as a central junction
that everything routes through. CoreMQ was descriptive but generic;
Plexus is distinctive in the MQTT/messaging space.

This PR is README-only. The Cargo crate (coremq-server) and npm
package (coremq-dashboard) keep their current names for now; a
follow-up PR will rename the binary, package, and config paths.

README rewrite highlights:

  - New tagline + opening that explains the architectural choice
    behind the name (single Tokio engine, async channels).
  - Lead with "At a glance" — seven bullets that cover the whole
    feature surface in 10 seconds.
  - Merge the redundant "MQTT Protocol Support" and "Multi-Transport
    Support" sections.
  - Architecture: keep the diagram, but the prose now explains why
    the single-threaded engine choice matters (lock contention story).
  - Performance and Security are paragraphs, not bullet lists.
    Drop marketing phrases like "zero-cost abstractions" that don't
    add information.
  - Topic Monitoring & REST Publish: trimmed the long JSON sample,
    kept the why-it-matters list and the curl examples.
  - QoS claims rewritten to match reality: "QoS 0 in production,
    QoS 1/2 wiring in progress." Removes the misleading
    "expandable to QoS 1/2" phrasing.
  - Roadmap: drop the WebSocket metrics endpoint (already shipped
    and documented above).
  - New Contributing section linking AGENTS.md, CONTRIBUTING.md,
    and CHANGELOG.md.
  - Honest callout that "Plexus" branding is ahead of the package
    rename, so readers don't get confused by `coremq-server` in
    build commands.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Warning

Rate limit exceeded

@Sardor-M has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 28 minutes and 26 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 021d686e-bcbb-406c-a428-64ef14ce4f4c

📥 Commits

Reviewing files that changed from the base of the PR and between e468206 and f00a882.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/rename-to-plexus

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Sardor-M Sardor-M requested a review from otabek05 May 8, 2026 07:44
@Sardor-M Sardor-M self-assigned this May 8, 2026
@Sardor-M Sardor-M added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels May 8, 2026
Copy link
Copy Markdown

@otabek05 otabek05 left a comment

Choose a reason for hiding this comment

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

Well done!

@otabek05 otabek05 merged commit f89796c into main May 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants