From f168c5c8e6387d321ce238f8d9eba21130afa8c4 Mon Sep 17 00:00:00 2001 From: Nicky Leach Date: Mon, 13 Jul 2026 23:26:46 +0000 Subject: [PATCH] docs: clarify trackProposed availability Co-authored-by: Paperclip --- doc/TELEMETRY_WORKFLOW.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/TELEMETRY_WORKFLOW.md b/doc/TELEMETRY_WORKFLOW.md index 7656e88e912..78ebd28b735 100644 --- a/doc/TELEMETRY_WORKFLOW.md +++ b/doc/TELEMETRY_WORKFLOW.md @@ -13,6 +13,11 @@ not contain that event yet. Use `trackProposed()` only for first-party Paperclip product telemetry. Do not use it for plugin, third-party, test, debug, or ad-hoc analytics events. +`trackProposed()` is the planned canonical helper for this workflow and may not +be available in every checkout yet. Before adding proposal call sites, check the +current telemetry client README and exports; when the helper is not present, +follow the current telemetry client guidance instead of assuming it has shipped. + The proposed event name is the future canonical event name. Do not prefix it with `proposed.`. @@ -67,7 +72,8 @@ backend review to clean up sensitive client payloads. Proposal inventory is based on static extraction. Keep call sites extractable: -- Import and call the canonical `trackProposed` helper from the telemetry client. +- Import and call the canonical `trackProposed` helper from the telemetry client + when it is available in your checkout. - Pass a string literal event name. Do not use variables, template literals, concatenation, or helper calls for the name. - Pass an inline object expression for dimensions. Do not use object variables,