Skip to content

docs: document the design-tool bridge and its findings - #121

Merged
xiduzo merged 1 commit into
design-bridge/4-studiofrom
design-bridge/5-docs
Sep 29, 2026
Merged

xiduzo merged 1 commit into
design-bridge/4-studiofrom
design-bridge/5-docs

Conversation

@xiduzo

@xiduzo xiduzo commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

Why

The docs described a contract no code implemented:

  • figma/<name> topics on the generic MQTT node, including in both Penpot pages and two templates;
  • microflow/v1/… topics with full VariableIDs;
  • a /set web route and a microflow-studio:// scheme for prototypes;
  • separate Host and Port fields;
  • a node "renamed to MQTT (Express)";
  • a README claim that a Penpot prototype can turn on an LED.

What changes

  • Plugin docs, Figma and Penpot: parallel structure. Each covers what the plugin does (editor-time, not prototypes), install, the single Broker URL field and default broker, the Bridge ID and where to find it in Studio, the MHB collection/token set with the type mapping, both directions of value flow, the raw ADR-0028 topic table for other MQTT clients, and limitations (no booleans in Penpot). The pages the plugins' help buttons open are the landing pages.
  • Design variable node page, updated how-tos, the "Link a sensor to Figma or Penpot" tutorial (matches the template), troubleshooting (Bridge ID, reachability, mosquitto_sub microflow/<id>/#), the glossary, the MQTT node page, and the home page string.
  • README, ARCHITECTURE (packages/design-bridge, the protocol seam), SECURITY (plain-text plugin credentials, allowedDomains: ["*"], rejectUnauthorized: false, the Bridge ID as the only separation on a public broker), QA and TECH.
  • docs/plans/design-tool-bridge.md: the plan, its decisions, and §6 Outcome and findings: what was built, where the build differs from the plan, the Penpot and Figma API findings, verification, and what is still open.

Verification

  • bun run types:check and a full bun run build of apps/fumadocs pass.
  • Every internal /docs/… link and anchor resolves.

🤖 Generated with Claude Code

Rewrite the plugin, node, how-to, tutorial and troubleshooting docs
around what the code does: one protocol, the Bridge ID, the MHB
collection/token set and type mapping, editor-only (neither tool runs
plugins in prototype mode), the working default broker, and the raw
topic table for other MQTT clients. Remove the contract no code
implemented (`figma/<name>` topics, `microflow/v1/…`, full VariableIDs
in topics, the `/set` link workaround, Host/Port fields), and the claim
that a Penpot prototype can drive an LED.

Update README, ARCHITECTURE, SECURITY (plain-text plugin credentials,
allowedDomains, rejectUnauthorized, public broker), QA and TECH, and
record the outcome and findings in docs/plans/design-tool-bridge.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@xiduzo
xiduzo added this pull request to stack #122 September 26, 2026 18:17
@xiduzo xiduzo changed the title docs: document the design-tool bridge for Figma and Penpot docs: document the design-tool bridge and its findings Sep 26, 2026
@xiduzo
xiduzo merged commit 6a307d6 into main Sep 29, 2026
17 checks passed
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.

1 participant