Skip to content

The open-source app everyone uses to manage agents at work

docs: add telemetry marker workflow (#9543)

Nicky Leach24bbc0f57e96
diff --git a/README.md b/README.md
index 7473045c8a..35f6849560 100644
--- a/README.md
+++ b/README.md
@@ -410,6 +410,7 @@ Paperclip ships with opt-in OpenTelemetry auto-instrumentation for the server (t
Paperclip collects anonymous usage telemetry to help us understand how the product is used and improve it. No personal information, issue content, prompts, file paths, or secrets are ever collected. Private repository references are hashed with a per-install salt before being sent.
Contributors changing emitted telemetry events should follow the [Telemetry Data Contract](packages/shared/src/telemetry/README.md).
+For proposed first-party events that are not in the generated contract yet, follow [Telemetry Workflow](doc/TELEMETRY_WORKFLOW.md).
Telemetry is **enabled by default** and can be disabled with any of the following:
diff --git a/packages/shared/src/telemetry/README.md b/packages/shared/src/telemetry/README.md
index ae4aad4e11..26c4c6374e 100644
--- a/packages/shared/src/telemetry/README.md
+++ b/packages/shared/src/telemetry/README.md
@@ -122,6 +122,10 @@ Before opening a pull request, verify that the emitted code, typed helpers, and
generated telemetry contract agree. If they disagree, fix the contract or code
rather than documenting around the mismatch in this README.
+For new first-party events that are not in the generated contract yet, follow
+the public proposal and promotion workflow in
+[`doc/TELEMETRY_WORKFLOW.md`](../../../../doc/TELEMETRY_WORKFLOW.md).
+
## Retention
Retention windows are documented in `retention.ts`. Each event is assigned a