From 03e6ef7f849ca88e595fb589a487869a6f6c48b3 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Tue, 14 Jul 2026 21:51:13 +0800 Subject: [PATCH] docs(telemetry): correct @page docs for branch-delete and sql autosave-disable events (#47922) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit _Requested by **Pam Chia** ยท [Slack thread](https://supabase.slack.com/archives/C076KTY11DF/p1783905235047469)_ ## What kind of change does this PR introduce? Docs update (JSDoc comments only in the telemetry catalog โ€” no runtime code, event names, or property types change). ## What is the current behavior? In `packages/common/telemetry-constants.ts`: - **Before:** The catalog only documented branch deletion as happening from the branches page. `branch_delete_button_clicked` listed a single `@page` of `/dashboard/project/{ref}/branches`, even though the button also fires from the merge page and from project Settings > General. - The `sql_editor_autosave_disable_clicked` event's `@page` read `/project/{ref}/sql/{id}`, missing the `/dashboard` prefix used by every sibling SQL-editor event. ## What is the new behavior? - **After:** `branch_delete_button_clicked` now documents all three surfaces where the button fires โ€” the branches page, the merge page, and project Settings > General (`/dashboard/project/{ref}/branches, /dashboard/project/{ref}/merge or /dashboard/project/{ref}/settings/general`). - `sql_editor_autosave_disable_clicked` now uses `/dashboard/project/{ref}/sql/{id}`, consistent with the other SQL-editor events. ## Additional context **How:** Both changes are `@page` JSDoc edits in `packages/common/telemetry-constants.ts`, touching the JSDoc blocks for `BranchDeleteButtonClickedEvent` and `SqlEditorAutosaveDisableClickedEvent`. The multi-page format mirrors the comma/"or" style already used by other multi-page events in the same file. The Settings > General call site was added in #47677 (`apps/studio/components/interfaces/Settings/General/DeleteBranchPanel.tsx`); the merge-page and branches-page call sites are in `apps/studio/pages/project/[ref]/merge.tsx` and `apps/studio/pages/project/[ref]/branches/index.tsx`. ๐Ÿค– Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_012mb6VWEpgrDYhgi7eyRpco --- _Generated by [Claude Code](https://claude.ai/code/session_012mb6VWEpgrDYhgi7eyRpco)_ Co-authored-by: Claude --- packages/common/telemetry-constants.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/common/telemetry-constants.ts b/packages/common/telemetry-constants.ts index 5d56aa66b3c..2a7b3a8f20b 100644 --- a/packages/common/telemetry-constants.ts +++ b/packages/common/telemetry-constants.ts @@ -700,7 +700,7 @@ export interface SqlEditorTemplateClickedEvent { * * @group Events * @source studio - * @page /project/{ref}/sql/{id} + * @page /dashboard/project/{ref}/sql/{id} */ export interface SqlEditorAutosaveDisableClickedEvent { action: 'sql_editor_autosave_disable_clicked' @@ -1776,7 +1776,7 @@ export interface BranchCreateButtonClickedEvent { * * @group Events * @source studio - * @page /dashboard/project/{ref}/branches + * @page /dashboard/project/{ref}/branches, /dashboard/project/{ref}/merge or /dashboard/project/{ref}/settings/general */ export interface BranchDeleteButtonClickedEvent { action: 'branch_delete_button_clicked'