docs: link the new telemetry page from the CLI reference and README#151
Draft
tembo[bot] wants to merge 1 commit into
Draft
docs: link the new telemetry page from the CLI reference and README#151tembo[bot] wants to merge 1 commit into
tembo[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Requesting review from @leoisadev1 who has experience with the following files modified in this PR:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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
Follow-up to #147, which added the
/docs/telemetrypage 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 thecli command runevent, that the first-run notice goes to stderr (so JSON on stdout still pipes cleanly intojq/scripts — ties into the adjacent Exit codes note), the env opt-outs, andNODE_ENV=test, then links to/docs/telemetryfor 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.ts—captureCliRun()emits thecli command runevent (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 toprocess.stderr;isTelemetryDisabledhonorsEMAIL_SDK_TELEMETRY,DO_NOT_TRACK, andNODE_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)/docs/telemetryconfirmed to existNot 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.