Skip to content

chore: remove Matrix references; quickstart shows room-UI flow#345

Merged
juliarvalenti merged 2 commits into
mainfrom
chore/remove-matrix-references
Jun 10, 2026
Merged

chore: remove Matrix references; quickstart shows room-UI flow#345
juliarvalenti merged 2 commits into
mainfrom
chore/remove-matrix-references

Conversation

@juliarvalenti

@juliarvalenti juliarvalenti commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Why

Standardizing on the new usage pattern: Mycelium is driven through the native room UI. Agents are provisioned via the agent primitive (mycelium agent add/create), auto-wired through the mycelium-room channel, and coordinate in the room's live message stream — no separate chat platform to set up.

This removes the now-superseded Matrix-the-protocol material and reframes docs/UX around the room-UI flow. OpenClaw stays a first-class adapter.

What changed

Removed

  • before-and-after-matrix skill (the non-Matrix before-and-after skill using the mycelium-room channel remains)
  • docs/openclaw-matrix-setup.md

Reframed (Matrix → the Mycelium room UI as home channel; Discord/Slack as external examples)

  • Docs: hub-and-spoke.md, metrics.md, troubleshooting.md, reset-local-dev-environment.md (retitled, Synapse section + dead link removed)
  • OpenClaw plugin: dropped the MATRIX_USER_ID fallback in resolveHandle; reframed comments in notify-home.ts, return-address.ts, route.ts, plugin SKILL.md, handler.js, HOOK.md (return-trip mechanism kept working)
  • Telemetry: traces.py/collector.py examples → mycelium-room/discord; test fixtures matrixdiscord; backend room name e2e-matrix-xyze2e-room-xyz
  • HTML: adapters.html; index.html/reference.html regenerated from sources

Kept intentionally: CI build-matrix in release.yml, the historical CHANGELOG.md entry.

Quickstart rewrite

quickstart.md + the hand-styled index.html section now lead with the new flow:

mycelium ui open → create a room → add agents (agent create/add, auto-wires mycelium-room) → coordinate (chat box + @-mention in the stream, or agent invoke; consensus → PLAN tab) → share memory. The old two-terminal session join/await flow is demoted to a footnote pointer.

Verification

  • Final repo scan: zero remaining Matrix/Synapse references (outside the intentional keeps)
  • ruff check / ruff format --check / ty check clean on changed Python
  • CLI tests 306 passed (1 pre-existing env failure: test_agent_onboard execs a real openclaw binary not installed in this env; file untouched here)
  • Backend test_metrics.py 11 passed; collector/metrics tests 47 passed

Note for reviewer

reset-local-dev-environment.md now links to the hub-and-spoke guide via a cross-package relative path (../mycelium-cli/.../guides/hub-and-spoke.md) — correct but crosses package boundaries; happy to repoint if you prefer.

Standardize on the new usage pattern: Mycelium is driven through the
native room UI. Agents are provisioned via the agent primitive
(mycelium agent add/create), auto-wired through the mycelium-room
channel, and coordinate in the room's live message stream — no separate
chat platform to set up. Remove the now-superseded Matrix-the-protocol
material; OpenClaw stays a first-class adapter.

Remove all Matrix-the-protocol references (keep the CI build-matrix and
CHANGELOG history):
- delete before-and-after-matrix skill and docs/openclaw-matrix-setup.md
- reframe home-channel docs/plugin/skill to the Mycelium room UI
  (Discord/Slack as external examples)
- drop MATRIX_USER_ID fallback in plugin resolveHandle
- de-Matrix telemetry parser examples + test fixtures
- reset-local-dev-environment.md retitled, Synapse section + dead link removed

Rewrite the quickstart (quickstart.md + index.html) to lead with the new
flow: mycelium ui open -> create room -> add agents -> coordinate in the
room stream / PLAN tab -> share memory.
@juliarvalenti juliarvalenti force-pushed the chore/remove-matrix-references branch from 687b1da to 175fcab Compare June 10, 2026 21:47
Follow-up to the Matrix removal: the prior pass swapped "matrix" for
"discord"/"slack" as the example channel. The expected behavior is the
mycelium-room channel, so lead with it and use generic "external channel"
wording where the concept is still needed — don't name a third-party
brand as the default.

- telemetry parser/docs (traces.py, metrics.md): mycelium-room + "external channels"
- plugin skill/hooks/comments (SKILL.md, handler.js, HOOK.md, notify-home.ts,
  route.ts): home channel = the Mycelium room
- hub-and-spoke guide: drop the Discord/Slack brand list
- adapters.html: home-channel examples genericized
- test fixtures: channel="discord" -> "external"

Pre-existing "without Discord/Slack" contrast framing (README, index.html
Problem section) left intact — it reinforces that mycelium-room replaces
third-party chat.
@juliarvalenti juliarvalenti merged commit 2eb08c3 into main Jun 10, 2026
6 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.

1 participant