Skip to content

DX-2984: bundle Workflow source and docs - #212

Open
ytkimirti wants to merge 6 commits into
mainfrom
DX-2984-bundle-docs
Open

ytkimirti wants to merge 6 commits into
mainfrom
DX-2984-bundle-docs

Conversation

@ytkimirti

@ytkimirti ytkimirti commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Ship the Workflow source (src/) and docs (docs/, fetched with giget when packing) in the npm package so developers and coding agents can read them locally.
Link public APIs to the bundled docs with JSDoc @see, add caveats for the pitfalls agents hit (code outside steps, context.call callbacks and timeout units, event id characters, lookback notify, wfr_ prefix, millisecond sleepUntil), and fix wrong JSDoc examples. No runtime changes.
In an agent benchmark (4 Workflow tasks), full pass went from 21/36 to 11/16 and agent timeouts from 12/36 to 1/16.

@linear-code

linear-code Bot commented Sep 18, 2026

Copy link
Copy Markdown

DX-2984

@ytkimirti
ytkimirti marked this pull request as ready for review September 18, 2026 07:51
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