Skip to content

docs(scripting): match protocol names to the Editor and list the missing ones - #883

Open
neurowave wants to merge 4 commits into
mainfrom
docs/scripting-protocol-list
Open

docs(scripting): match protocol names to the Editor and list the missing ones#883
neurowave wants to merge 4 commits into
mainfrom
docs/scripting-protocol-list

Conversation

@neurowave

@neurowave neurowave commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Checked the protocols overview and each protocol page against ScriptProtocol and the labels the type picker renders.

Names that don't match the picker

Docs say Picker shows
Util Blank
Listener Action Script Listener Action
Transition Condition Script Transition Condition

"Util" doesn't appear anywhere in the editor. The label comes from ScriptProtocol.utility.label, which is 'Blank', so someone following the page looks for a menu entry that isn't there.

Missing from the overview list

The list had 7 of the 10 protocols available today:

  • Blank — already has a page and a sidebar entry, just not in this list
  • File Format — undocumented
  • Text File Format — undocumented

Both file format protocols get a one-line entry rather than a page, since neither has one yet. Verified user-reachable: the create menu renders every availableProtocols() entry by type.label.

Interpolator is excluded, still behind ENABLE_SCRIPTED_INTERPOLATORS (prod: enabledForEveryone: false). availableProtocols() filters exactly that one flag and nothing else.

mint broken-links passes.

…ing ones

The type picker labels three protocols differently from the docs: the
blank protocol is Blank rather than Util, and the listener action and
transition condition entries have no trailing Script.

The protocols overview also listed 7 of the 10 available protocols,
omitting the blank protocol (which already has a page in the sidebar) and
both file format protocols.
@neurowave
neurowave requested a review from a team as a code owner August 23, 2026 18:38
@mintlify

mintlify Bot commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
rive 🟢 Ready View Preview Aug 23, 2026, 6:40 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Match the terse imperative form the existing entries use.
The overview and the create step now say Blank, matching the picker, so
the page title and headings should not still say Util. Other protocol
pages are titled '<Protocol> Scripts' after the picker label.
unit-testing.mdx still referred to Util Scripts after the protocol page
was retitled.
---
title: "Unit Testing"
description: "Write and run unit tests for your Util Scripts using Test scripts."
description: "Write and run unit tests for your Blank Scripts using Test scripts."

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't really make sense. You don't write test for blank scripts.


## Creating a Listener Action Script

[Create a new script](/scripting/creating-scripts) and select **Listener Action Script** as the type.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the editor they are called Listener Action Scripts

@neurowave
neurowave requested a review from lancesnider August 24, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants