Skip to content
This repository was archived by the owner on Apr 19, 2026. It is now read-only.

docs(profile): rewrite org README with platform-neutral, verifiable copy#2

Merged
jesseoue merged 2 commits intomainfrom
docs/profile-readme-polish
Apr 19, 2026
Merged

docs(profile): rewrite org README with platform-neutral, verifiable copy#2
jesseoue merged 2 commits intomainfrom
docs/profile-readme-polish

Conversation

@jesseoue
Copy link
Copy Markdown
Contributor

Summary

Rewrite the LeadMagic organization profile README (profile/README.md, which is what renders at github.com/LeadMagic) so the copy matches the current product positioning on leadmagic.io, uses language we can stand behind, and steers clear of claims about specific third-party networks we don't operate.

The previous README leaned hard on unverifiable marketing numbers, referenced "LinkedIn enrichment" (which the current public API and website have already moved away from), and pointed to a docs.leadmagic.io host that redirects. This PR brings it into alignment with the way Marketing, Product, and the OpenAPI snapshot already describe LeadMagic.

What changed

Positioning and voice

  • Lead with the tagline used on the homepage: "The B2B Data API for AI Agents & GTM Engineers", with the subhead "API-first B2B data, anywhere you build."
  • Frame the product the way leadmagic.io frames it today: one API key, three surfaces — REST, CLI, and hosted MCP.
  • Call out the hosted MCP at https://mcp.leadmagic.io/mcp and link to the canonical per-client install discovery at https://mcp.leadmagic.io/clients.
  • Keep the ASCII wordmark and the bootstrapped / customer-funded framing.

Language cleanup

  • Remove all references to "LinkedIn" and any phrasing that could imply we scrape or index a specific third-party social network. Use platform-neutral language — "B2B profile enrichment", "professional profile URLs", "direct-dial numbers" — which matches the wording already used in leadmagic-openapi and the public docs.
  • Drop claims that aren't substantiated on the public site:
    • Hero-level "99% accuracy" superlative (the site uses 97% on specific endpoints).
    • "95% primary inbox", "300% response rates", "8x open rates".
    • "Fortune 500" branding.
    • "SOC 2 Certified" badge (not claimed on the website; keep GDPR only, which the FAQ does mention).
    • Fabricated customer testimonials and an unverifiable "1,200+ customers" stat.
    • Hard-coded monthly pricing tiers ($99.99 / $259.99).
  • Replace them with confident, defensible language and link out to the canonical pages that stay in sync (leadmagic.io, leadmagic.io/docs, leadmagic.io/pricing).

Structural improvements

  • New "Three ways to build with LeadMagic" section: a crisp table for REST / CLI / MCP, followed by a paragraph calling out the hosted MCP clients we ship install snippets for (Cursor, Claude, ChatGPT, VS Code / Copilot, Windsurf, Zed, Cline, Roo Code, OpenCode, Gemini CLI, JetBrains, Amazon Q, Copilot Coding Agent, Continue, Amp, Augment, Vercel AI SDK).
  • Core capabilities grid rewritten as a 3-column table (Contact / Company / Intent), pulling the capabilities from the public endpoint list so it's one-to-one with what customers can actually call today.
  • Pricing condensed to a single honest paragraph — "1 credit = 1 enrichment, pay for valid results, 100 free credits, no credit card" — and linked to /pricing.
  • Integrations list pulled straight from the homepage integrations carousel (Clay, Apollo, Instantly, Smartlead, Databar, Salesforge, n8n, Zapier, Make, plus the full AI-client list).
  • New "Open-source and public surfaces" section pointing at the two repos we actually maintain publicly (leadmagic-openapi, leadmagic-cursor-plugin) so visitors don't have to guess which LeadMagic/* repo is canonical.
  • New "Security and responsible use" section that cross-links the brand-impersonation allow-list in leadmagic-openapi/SECURITY.md and the security@leadmagic.io mailbox.
  • Contact table restored and trimmed to channels we actually monitor; copyright bumped to 2026.
  • Fixed the mojibake emoji (��) in the old feature grid header.

Rendered behaviour

This file is read from profile/README.md and becomes the org profile card at https://github.com/LeadMagic. GitHub will re-render it within a minute of merge.

Operational note: this repo was previously archived. I unarchived it to push this branch. After this PR merges (and any follow-up tweaks land), feel free to re-archive — the profile README still renders while archived, writes are just blocked.

Secret / link safety

  • No API keys, tokens, private URLs, or customer names in the file.
  • Grepped the final file for LinkedIn, scrape, SOC 2, Fortune, 99%, 95%, 300%, 8xzero matches.
  • Every outbound link points to a leadmagic.io, mcp.leadmagic.io, app.leadmagic.io, github.com/LeadMagic/*, mailto:*@leadmagic.io, or twitter.com/leadmagichq target.

Test plan

  • git diff --stat — single-file change, profile/README.md, −194 / +82 lines.
  • Markdown renders cleanly locally (no stray HTML, no unbalanced <div> blocks, no broken tables).
  • All badges and links resolve (previewed shields.io tags and the three anchor URLs).
  • Visual check on https://github.com/LeadMagic after merge.

Out of scope

  • Repo-root README.md (still the default one-liner; can be a follow-up if we want the browse view to also have something).
  • SDK, integration, or product repos — this PR only touches org-profile copy.

Rework the LeadMagic organization profile README so the rendered
github.com/LeadMagic page matches the current product positioning on
leadmagic.io, uses language we can stand behind, and steers clear of
claims about specific third-party platforms we do not operate.

Key changes:

- Lead with the current tagline ("The B2B Data API for AI Agents and
  GTM Engineers") and the REST + CLI + MCP surface model used on the
  marketing site.
- Remove references to "LinkedIn" and any phrasing that could imply we
  scrape or index a specific social network. Use platform-neutral terms
  like "B2B profile enrichment", "professional profile URLs", and
  "direct-dial numbers", matching the public OpenAPI snapshot.
- Drop unverifiable marketing claims (99% accuracy hero stat, 95%
  primary-inbox figures, 300% / 8x response-rate anecdotes, Fortune 500
  branding, SOC 2 Certified badge, fabricated testimonials, fixed
  monthly pricing tiers). Replace with neutral language and link to the
  canonical pages (leadmagic.io, /docs, /pricing) that stay in sync.
- Point all doc links at the canonical leadmagic.io/docs host instead
  of docs.leadmagic.io, which redirects.
- Fix mojibake (corrupt emoji in the feature grid header) and the
  outdated copyright year (2025 -> 2026).
- Feature the public repos we actually maintain — leadmagic-openapi
  and leadmagic-cursor-plugin — and the hosted MCP entrypoint,
  including the public client-discovery endpoint at
  mcp.leadmagic.io/clients.
- Cross-link the brand-impersonation guidance in
  leadmagic-openapi/SECURITY.md so visitors who find a third-party
  "LeadMagic" package have an authoritative allow-list to check.
- Keep the ASCII wordmark and the bootstrapped / customer-funded
  framing, but cut superlatives and anything that implies claims we
  have not publicly substantiated.
The repo-root README.md was the default `# .github` placeholder, which
is what visitors see when they browse the repo directly. Replace it
with a short, professional pointer that:

- states this is a meta/community-health repository and not a product
  repo, and links out to the GitHub docs explaining what a `.github`
  repo is;
- directs visitors looking for code to the two canonical public repos
  (leadmagic-openapi, leadmagic-cursor-plugin) and the current product
  docs / MCP endpoint / dashboard;
- reinforces the editing convention (profile/README.md is the public
  org page) and cross-links the brand-impersonation allow-list in
  leadmagic-openapi/SECURITY.md so anyone about to submit a PR here
  sees the positioning rules before they start typing;
- surfaces the security and support mailboxes.

Included in the same PR as the profile rewrite because it is the same
class of org-facing documentation and they should ship together.
@jesseoue
Copy link
Copy Markdown
Contributor Author

Follow-up commit 437b6e0 addresses the one item I called out as out-of-scope in the PR description: the repo-root README.md was still the default # .github placeholder, which is what anyone sees when they browse this repository directly rather than the org profile page. Replaced it with a short pointer that:

  • explains this is the org meta-repo (profile/README.md renders the public org page) and links to GitHub's docs on the .github repository;
  • redirects visitors looking for code to leadmagic-openapi, leadmagic-cursor-plugin, leadmagic.io/docs, and mcp.leadmagic.io/mcp;
  • cross-links the brand-impersonation allow-list in leadmagic-openapi/SECURITY.md so future edits to the profile inherit the same guard rails;
  • surfaces the security@leadmagic.io and support@leadmagic.io mailboxes.

Post-merge operational note

This repo was previously archived — I unarchived it only to push this branch. Once this PR merges, running

gh api -X PATCH repos/LeadMagic/.github -f archived=true

will re-archive it. Archiving does not affect how profile/README.md renders on the org page; it only blocks further writes. Happy to do this as a follow-up if you'd like.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant