Skip to content

Flow node help in business words: approval config describe text and node palette descriptions are written for engineers (#27356 row 15, #27521 row 39) #27838

Open

Description

@objectstack-fleet

domain:ui#3 · os-bill · session_01Utp6CaJoinvGQSbHeDaWBe

Filing gate: ③ triage-directed. Triage on #27356 (row 15) and #27521 (row 39) split each row into a Studio half (taken in a ui PR) and a producer half (the words themselves), which lives outside domain:ui. This card is the producer half of both rows.
Reach: observed on the 18.3.0 RC browser walkthrough at c4c515ad (admin, desktop); re-read on current main.
Reader who acts: domain:spec (the approval.zod.ts describe text) and the owner of the node descriptors (service-automation, plugin-approvals) for part 2.
Duplicate search: search_issues "flow node help engine prose describe business words approval excludeSubmitter ADR-0105 node palette description" → no open card covering it.

Observed

Studio shows the schema describe text as the field help on flow node inspectors, and the node descriptor description as the palette and node card text. Both are written for engineers:

  1. packages/spec/src/automation/approval.zod.ts
    • excludeSubmitter help names submitter_id, onEmptyApprovers, admin_rescue, fallbackApprovers and the quoted enum values.
    • Approver organization help opens with "ADR-0105 D9 —" and lists $root / $parent tokens.
  2. Node descriptor descriptions (palette, node cards):
    • packages/services/service-automation/src/builtin/http-nodes.ts: "HMAC-SHA256 secret → X-Objectstack-Signature", "durable outbox (retry/dead-letter)", "a literal, read as written".
    • packages/plugins/plugin-approvals/src/approval-node.ts node description.

Wanted

Help text an admin can act on: what the setting does to the request, in business words, with no ADR ids, internal field names or enum literals in the first sentence. Engineer detail can stay in JSDoc. Studio already clamps long help (PR #27832, Learn more above 120 chars), so the first sentence carries the meaning.

Part 1 is a spec describe change (check check-sdui-manifest / generated docs that quote it). Part 2 may need its own card if the descriptor owner is a different lane; split at claim.

Related: #27356 (row 15), #27521 (row 39), PR #27832.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions