Repository navigation
[SCAL-352445] Lead HostEvent and EmbedEvent descriptions with what they do - #749
Merged
Merged
Conversation
The description opened with "Trigger Pin action on an embedded object", which names the mechanism, and only said it adds an Answer to a Liveboard in its third sentence. Readers and docs search (the spotter-code MCP) match on the task, so the task now comes first. Same content, reordered; no API change.
commit: |
…ey do
28 HostEvent descriptions opened with "Trigger the X action" or "Triggers ..."
and only later, if at all, said what happens. They now lead with the effect and
keep the UI label ("..., the same as the **X** action"). 18 EmbedEvent
descriptions were fragments ("Rendering has initialized."); they now use the
"Emitted when ..." form the other members use. Reordered and rephrased only:
no facts removed, no tags, examples or API changed.
ruchI9897
approved these changes
Nov 17, 2026
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.
What
Rewrites HostEvent and EmbedEvent descriptions so each one opens with what it does. The content is the same, reordered.
Pin): openers like "Trigger the X action on …" now lead with the effect and keep the UI label, e.g. "Make a copy of a Liveboard, visualization, or Answer page, the same as the Make a copy action."The rules:
Skipped on purpose:
Why
People search for the task, e.g. "save an answer to a Liveboard", not "pin action". The spotter-code MCP retrieves these docs for AI agents, and mechanism-first openers get missed.
HostEvent.Pinmeasured on the staging index: it scores 0.465 against a vector top-20 cutoff of about 0.513.Suspected wrong descriptions (not changed here; need an owner to confirm)
EmbedEvent.AuthLogoutandIdleSessionTimeout: the text reads likeAuthFailure's ("failed to validate the auth session").EmbedEvent.CreateConnection: "updates a connection" is copied fromUpdateConnection.HostEvent.Remove: the prose says it deletes a Liveboard, but its payload note requiresvizId.HostEvent.RefreshLiveboardBrowserCache: itsScheduleEmailRequestpayload looks copied fromSendTestScheduleEmail.EmbedEvent.ExportTML) and "edit mode , equivalent" (HostEvent.ExitEditMode).Testing
eslint src/types.tsis clean.src/types.ts.