Skip to content

docs: link the new telemetry page from the CLI reference and README#151

Draft
tembo[bot] wants to merge 1 commit into
mainfrom
tembo/link-telemetry-docs
Draft

docs: link the new telemetry page from the CLI reference and README#151
tembo[bot] wants to merge 1 commit into
mainfrom
tembo/link-telemetry-docs

Conversation

@tembo

@tembo tembo Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #147, which added the /docs/telemetry page but left it unlinked from the two surfaces where a reader is most likely to look for it. This wires up that discoverability gap. Documentation-only; no behavior changes.

Docs added/updated

  • apps/fumadocs/content/docs/reference/cli.mdx — new short Telemetry section. The CLI reference previously never mentioned that the CLI phones home. Notes the cli command run event, that the first-run notice goes to stderr (so JSON on stdout still pipes cleanly into jq/scripts — ties into the adjacent Exit codes note), the env opt-outs, and NODE_ENV=test, then links to /docs/telemetry for the full detail rather than duplicating it.
  • README.md — added a one-line pointer from the Telemetry section to the telemetry docs for the full event list, redaction, CI detection, and opt-outs.

Codepaths covered

Every claim verified against source, not fabricated:

  • packages/email-sdk/src/cli.tscaptureCliRun() emits the cli command run event (command, adapter, dry_run, success, duration_ms, error_code); setTelemetrySource("cli") at process start; telemetry.flush() before exit.
  • packages/email-sdk/src/telemetry.ts — first-run notice written to process.stderr; isTelemetryDisabled honors EMAIL_SDK_TELEMETRY, DO_NOT_TRACK, and NODE_ENV=test.

Key knowledge gap addressed

A CLI user reading only the CLI reference had no way to learn the CLI emits anonymous telemetry or how to turn it off, and the README (which duplicates a telemetry summary) never pointed at the canonical, more detailed docs page. Both now route to /docs/telemetry.

Validation

  • cd apps/fumadocs && bun run types:check — green (fumadocs-mdx && tsc --noEmit)
  • Internal link target /docs/telemetry confirmed to exist

Not changed

The rest of the docs were audited (adapters, client/message/CLI references, concepts, guides, convex-email component, and the new telemetry page verified against telemetry.ts) and are already accurate and current post-#147 — so no other edits, keeping this PR clean and focused.


Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo View Agent Settings View on automation

@tembo tembo Bot added the tembo Pull request created by Tembo label Jul 6, 2026
@tembo tembo Bot requested a review from leoisadev1 July 6, 2026 19:26
@tembo

tembo Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Requesting review from @leoisadev1 who has experience with the following files modified in this PR:

  • README.md
  • apps/fumadocs/content/docs/reference/cli.mdx

@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
email-sdk-fumadocs Ready Ready Preview, Comment Jul 6, 2026 7:27pm

Request Review

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

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants