Skip to content

docs: present Pulse as three clients in the root README - #487

Merged
emaarco merged 1 commit into
mainfrom
emaarco/docs-readme-move-quickstart
Oct 27, 2026
Merged

emaarco merged 1 commit into
mainfrom
emaarco/docs-readme-move-quickstart

Conversation

@emaarco

@emaarco emaarco commented Oct 27, 2026

Copy link
Copy Markdown
Member

Why

The root README still read like the MCP-only Miragon AI repo: an MCP quick start, an MCP widget image and the migration note sat at the top level, while Pulse now ships three clients (MCP server, CLI, VS Code) for the same engines.

What

  • Root README: introduces the three clients as equals, a single "Get started" table (install + README + docs per client), client-neutral "Why" points, docs links per client, and the VS Code extension listed in Releases.
  • Moved the MCP quick-start hint and the widget image into apps/mcp-server-camunda7/README.md.
  • Moved the "Renamed from miragon-ai" note into the server README; the root links to it. The old-names allowance and CLAUDE.md point to the new location.

Verification

  • pnpm format:check passes
  • old-names.test.ts and docs-refs.test.ts pass (200 tests)

@emaarco
emaarco enabled auto-merge (squash) October 27, 2026 14:48
@netlify

netlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for spectacular-cobbler-f6c85b ready!

Name Link
🔨 Latest commit 2d401d5
🔍 Latest deploy log https://app.netlify.com/projects/spectacular-cobbler-f6c85b/deploys/6ae0b9c24ad8ea1ad930e288
😎 Deploy Preview https://deploy-preview-487--spectacular-cobbler-f6c85b.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@emaarco
emaarco merged commit 4ab3caa into main Oct 27, 2026
27 checks passed
@emaarco
emaarco deleted the emaarco/docs-readme-move-quickstart branch October 27, 2026 14:58
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