docs: update sign up instructions#3
Merged
Conversation
The web app's /register page silently captures `?intent=sdk` from the
URL and routes the user to /install/sdk after signup, skipping the
payment-provider step they don't need. Until now the SDK READMEs
linked to churnkey.co (the marketing site) which sends signups
through the default flow.
- Top-level README: add a "Sign up free" line in the resources list
with the intent param. Keeps the marketing-site link for general
context.
- packages/react/README.md "Add analytics": link directly to the
intent=sdk register page. Make the free-tier framing explicit
("Analytics is included on every plan and works without a billing
provider connection") so SDK users know they don't need to set up
Stripe to get analytics.
- packages/mcp/README.md Setup: same intent link for the
"Don't have an account?" path. Also fix a stale URL — Data API
Keys live at /settings/organization, not /settings/data-api.
packages/node/README.md is intentionally untouched: the audience
is server-side dev in token mode (paid features), already invested
in a Churnkey account, and a CTA at the top would be noise.
Companion to monorepo PR #179 (rob/sdk) which adds the intent
handling to the register page and the /install/sdk landing flow.
Same fix as churnkey-docs PR #101 review note. The bundled section pointed at claude_desktop_config.json for both clients, but that file is Claude Desktop only — Claude Code uses `claude mcp add`, `.mcp.json`, or `~/.claude.json` (single file, not directory). Two subsections now: Claude Desktop with the JSON config (macOS + Windows paths), Claude Code with the `claude mcp add` CLI as the recommended path and the file-based alternatives noted.
robert-moore
changed the title
Review feedback — the React "Add analytics" line read as ad copy rather than docs prose. Strip the "Analytics is included on every plan and works without a billing provider connection" sentence and the parallel qualifiers in the other two READMEs (top-level and MCP). Stripe-style: tell developers what to do, skip the upsell. Result: clean imperative sentences with the link, no qualifications.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve sign up instruction for free Churnkey analytics account