Skip to content

Commit 8a7ee95

Browse files
alex-spataruclaude
andcommitted
docs(ai): clear documentation-verify advisories in output-widget docs
Convert definition-list em-dashes to colons to drop em-dash density below threshold, and replace a "see below" rot reference with a section link. Rebuild the AI search index. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 20afcd5 commit 8a7ee95

3 files changed

Lines changed: 11 additions & 10 deletions

File tree

app/rcc/ai/docs/output_widget_js.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Output Widgets JavaScript "transmit function" API
1+
# Output Widgets: JavaScript "transmit function" API
22

33
Output widgets (Pro) translate UI state into bytes the device receives.
44
Each widget instance has one user-authored JS function that runs on every
@@ -28,9 +28,9 @@ function transmit(value) {
2828

2929
Return either:
3030

31-
- a **String** encoded using the widget's configured TX encoding and sent,
32-
- a **byte array** (`Uint8Array` or `Array<number>`) sent verbatim,
33-
- `null` / `undefined` / an empty result nothing is sent.
31+
- a **String**: encoded using the widget's configured TX encoding and sent,
32+
- a **byte array** (`Uint8Array` or `Array<number>`): sent verbatim,
33+
- `null` / `undefined` / an empty result: nothing is sent.
3434

3535
There is a maximum payload size; oversized returns are dropped with an error.
3636

app/rcc/ai/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

app/rcc/ai/skills/output_widgets.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ the device. Each one belongs to a group and has its own JavaScript
66

77
**Output transmit functions are JavaScript-only** — the Lua-first
88
guidance in the `frame_parsers` and `transforms` skills does NOT apply
9-
here. A small set of Modbus/CAN protocol helpers is JS-bound (see below);
10-
author transmit functions in JS, Lua will not compile.
9+
here. A small set of Modbus/CAN protocol helpers is JS-bound
10+
(see [The transmit function](#the-transmit-function)); author transmit
11+
functions in JS, Lua will not compile.
1112

1213
## Five widget types
1314

@@ -32,10 +33,10 @@ project.outputWidget.get{groupId, widgetId} // read current config
3233

3334
Each widget has:
3435

35-
- `title`, `icon` UI labels
36-
- `minValue`, `maxValue`, `stepSize`, `initialValue` numeric range
36+
- `title`, `icon`: UI labels
37+
- `minValue`, `maxValue`, `stepSize`, `initialValue`: numeric range
3738
(sliders, knobs)
38-
- `transmitFunction` JS source that returns the bytes to send
39+
- `transmitFunction`: JS source that returns the bytes to send
3940

4041
## The transmit function
4142

0 commit comments

Comments
 (0)