6a063a3e5f
docs: add vite getting started ( #285 )
...
* refactor: migrate to latest nitro v3
Signed-off-by: Pooya Parsa <pooya@pi0.io >
* update workaround
* fix(nitro): nitro builder using deprecated srcDir
* fix: add back nitro config
* fix: testing matrix dirs
* fix(hono): externalize nitro workflow output dir
* chore: format
* fix(nitro): externalize .nitro/workflow folder
* docs(hono): update getting started
* update docs and workbench
* improve plugin patch
* test: fix hono dev config
* fix: wrong api file path in hono dev config
* fix(nitro): check all dirs for builder
* chore: add comments
* refactor: migrate to latest nitro v3
Signed-off-by: Pooya Parsa <pooya@pi0.io >
* docs: update home page frameworks
* update getting started stuff and add vite page
* docs: update vite getting started page
* Update docs/app/(home)/components/frameworks.tsx
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* Update docs/content/docs/getting-started/index.mdx
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* Apply suggestion from @adriandlam
* Update docs/app/(home)/components/frameworks.tsx
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* lockfile
* lockfile
* docs: update vite getting started guide
* format
* format
* format
* reset packages/nitro/src/index.ts
* docs: fix vite getting started
* docs: fix vite getting started api route
* revert
---------
Signed-off-by: Pooya Parsa <pooya@pi0.io >
Co-authored-by: Pooya Parsa <pooya@pi0.io >
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
2025-11-19 15:18:50 -08:00
0337f16ae0
Fix 'getWritable()' docs page to not write to stream in workflow function ( #364 )
2025-11-18 17:22:54 -08:00
ee25bd9d55
refactor: upgrade to latest nitro v3 ( #293 )
...
* refactor: migrate to latest nitro v3
Signed-off-by: Pooya Parsa <pooya@pi0.io >
* update workaround
* fix(nitro): nitro builder using deprecated srcDir
* fix: add back nitro config
* fix: testing matrix dirs
* fix(hono): externalize nitro workflow output dir
* chore: format
* fix(nitro): externalize .nitro/workflow folder
* docs(hono): update getting started
* changeset
* update docs and workbench
* improve plugin patch
* docs: preserve code style
* update `getWorkflowDirs`
* update vite workbench
* test: fix hono dev config
* fix: wrong api file path in hono dev config
* fix(nitro): check all dirs for builder
* chore: add comments
---------
Signed-off-by: Pooya Parsa <pooya@pi0.io >
Co-authored-by: Adrian Lam <me@adriandlam.com >
2025-11-17 16:53:38 -08:00
510c55ba1d
Update grammar in workflow docs ( #334 )
...
Improved grammar in the workflow documentation as requested.
## Files Modified:
### Core Documentation Files:
- `README.md` - Main repository README
- `docs/content/docs/foundations/index.mdx` - Foundations overview
- `docs/content/docs/foundations/workflows-and-steps.mdx` - Core concepts documentation
- `docs/content/docs/foundations/starting-workflows.mdx` - Workflow startup guide
- `docs/content/docs/foundations/control-flow-patterns.mdx` - Control flow documentation
- `docs/content/docs/foundations/errors-and-retries.mdx` - Error handling guide
- `docs/content/docs/foundations/hooks.mdx` - Hooks and webhooks documentation
### Getting Started Guides:
- `docs/content/docs/getting-started/next.mdx` - Next.js integration guide
- `docs/content/docs/getting-started/hono.mdx` - Hono integration guide
### API Reference:
- `docs/content/docs/api-reference/workflow/sleep.mdx` - Sleep function documentation
### Deployment Documentation:
- `docs/content/docs/deploying/index.mdx` - Deployment guide
## Types of Grammar Issues Fixed:
1. **Articles and Determiners**:
- Added missing articles ("a", "an", "the") where appropriate
- Fixed article usage consistency
2. **Verb Forms and Tenses**:
- Corrected "has passed" → "passes" for better flow
- Fixed "needs" → "need" for proper subject-verb agreement
- Changed "will go a long way in helping" → "will go a long way toward helping"
3. **Comma Usage**:
- Added missing commas in compound sentences
- Fixed comma placement before "and" in complex sentences
- Added commas after introductory clauses
4. **Word Choice and Clarity**:
- Changed "really simple" → "simple" for more professional tone
- Fixed "setup" → "set up" (verb form vs noun form)
- Changed "newly made" → "newly created" for better precision
- Improved "the external system" → "external systems" for consistency
- Fixed "propagate the error over to" → "propagate the error to"
5. **Sentence Structure**:
- Combined fragmented sentences for better flow
- Fixed run-on sentences by adding proper punctuation
- Improved parallel structure in lists and descriptions
6. **Punctuation and Formatting**:
- Changed "Learn more:" → "Learn more": for consistency
- Fixed em-dash usage (- → —) where appropriate
- Added backticks around code terms like `start()` for consistency
7. **Pronoun and Reference Clarity**:
- Fixed unclear pronoun references
- Made subject-verb agreements consistent
- Improved clarity of "them" and "it" references
## Implementation Approach:
- Systematically reviewed key documentation files
- Applied consistent grammar rules across all files
- Maintained the existing technical tone and style
- Preserved all code examples and technical accuracy
- Focused on readability improvements without changing meaning
The grammar improvements make the documentation more professional and easier to read while maintaining all technical accuracy and existing functionality.
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
2025-11-16 11:46:16 -08:00
9e179a8c23
ci: move linting links to separate job ( #339 )
...
* ci: move linting links to separate job
* ci: add lint workflow
* ci: update job name
* ci: remove bun setup
2025-11-13 19:57:20 -08:00
aa015af89d
feat(world-local): add baseUrl config and improve port handling ( #260 )
2025-11-13 11:30:57 -08:00
498bde261d
New stream docs and imrpove serializaiton docs ( #328 )
2025-11-13 07:12:38 -08:00
d113251548
Add 'Pass-by-Value Semantics' section to serialization docs ( #254 )
...
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-12 17:52:29 -08:00
6419962496
Fix grammar errors in documentation ( #320 )
...
* Fix grammar errors in documentation
Fixed grammar errors in the documentation as requested.
## Changes Made
**Modified Files:**
- `CLAUDE.md` - Fixed 3 grammar errors:
- "propogate" → "propagate"
- "changeset" → "changesets" (added missing plural)
- "amke chagnesets" → "make changesets"
- Added missing closing quote for "**BREAKING CHANGE**"
- `docs/content/docs/foundations/index.mdx` - Fixed 2 grammar errors:
- "real world" → "real-world" (hyphenated compound adjective)
- "go a long way in using workflows" → "go a long way in helping you use workflows effectively" (improved clarity and grammar)
- `docs/content/docs/foundations/workflows-and-steps.mdx` - Fixed 2 grammar errors:
- "resume to workflow" → "resume the workflow"
- "each time, using" → "each time using" (removed unnecessary comma)
- "workflows are run in" → "workflows run in" (improved verb form)
- `docs/content/docs/foundations/errors-and-retries.mdx` - Fixed 3 grammar errors:
- Missing space: "RetryableError`](/docs...)and" → "RetryableError`](/docs...) and"
- "we've learnt" → "we've learned" (consistent American English)
- "Rolling back failed steps" → "Rolling Back Failed Steps" (proper title case)
- `packages/workflow/README.md` - Fixed 1 grammar error:
- "engineers are" → "engineers are:" (added missing colon before list)
## Summary
Total of 11 grammar errors fixed across 5 documentation files. The fixes include:
- Spelling corrections (propogate → propagate, learnt → learned)
- Punctuation improvements (missing spaces, colons, quotes)
- Grammatical improvements (verb forms, compound adjectives)
- Style consistency (American English, title case)
All changes maintain the original meaning and formatting while improving readability and professional presentation of the documentation.
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
* Changeset
---------
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: Peter Wielander <mittgfu@gmail.com >
2025-11-12 17:35:57 -08:00
ed1c71f516
[docs] add o11y hint at the end of example code ( #313 )
2025-11-12 10:45:05 -08:00
6373ab5a1f
resumeHook() now throws errors (#286 )
...
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-09 13:26:38 -08:00
de04cea3dc
Finish renaming "embedded" world to "local" in docs ( #269 )
...
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-07 23:30:47 -08:00
120ae06115
Improvements to docs emphasizing the 'schema' property usage ( #257 )
...
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-07 19:33:16 -08:00
fb8153bec4
feat: add Nuxt module and documentation ( #187 )
...
* feat: add Nuxt module and documentation
* fix: add the prepare in the build command
* Apply suggestion from @vercel[bot]
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* chore: simplify usage without /nuxt
* wip
* Update nuxt.mdx
Co-Authored-By: Daniel Roe <daniel@roe.dev >
* add clean command and ignore prepare
* use @workflow/nitro
* Changeset
Added a Nuxt module and updated documentation accordingly.
* feat: enable typescript plugin in tsconfig
* chore: revert accordion value
* chore: use symlink
* fix: json parsing in trigger route for nitro-v2
* ci: add e2e tests for nuxt
* ci: add nuxt to test matrix
* chore: make sure to add /nuxt to avoid conflicts when importing entry-points
* chore: move typescriptPlugin option to Nitro
* chore: body is already parsed
* fix: use readRawBody
* fix: use rawBody in hook.post too
* chore: add missing import (but not required)
* chore: update pm
* Create resolve-symlinks.sh
* chore: add also node-rs/xxhash
* Update create-test-matrix.mjs
* update matrix
* Update create-test-matrix.mjs
* remove symlink to nitro-v2
---------
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: Daniel Roe <daniel@roe.dev >
Co-authored-by: Pranay Prakash <pranay.gp@gmail.com >
Co-authored-by: Adrian Lam <me@adriandlam.com >
2025-11-08 01:10:59 +01:00
adf0cfeb91
feat: add getPort for detecting pid port ( #233 )
...
* feat: add getPort method for detecting pid port
* lockfile
* update tests and fix getPort usage
* changeset
* docs: update sveltekit getting started
* fix: use pid-port
* fix: not using config port env
* fix: remove unused getPort from world core
* remove unused stuff
* fix: world local config returning port 3000 as fallback
* changeset
* fix: rebase conflicts
* fix: util test missing http import
* changeset
* fix: wrong import for getPort in core runtime
* fix: getPort in @workflow/utils being imported into workflow runtime
* test: simplify sveltekit test
* fix missing import in test
* fix: async await stuff with getPort
* refactor: move getPort to @workflow/utils/get-port
* test: simplfiy getPort tests
* test: fix sveltekit ports
2025-11-07 14:36:36 -08:00
51e6d12d76
Simplify webhook 'Static Response' code example
...
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-07 00:16:57 -08:00
353999c889
Restore code block animation on mobile ( #246 )
2025-11-06 17:08:11 -08:00
7013f29f46
Change RetryableError "retryAfter" option number value to represent milliseconds instead of seconds ( #240 )
...
Changed `RetryableError` to use milliseconds instead of seconds for numeric `retryAfter` values.
### What changed?
- Modified the `RetryableError` class to interpret numeric `retryAfter` values as milliseconds instead of seconds
- Updated documentation and examples to reflect this change
- Added dependency on `@workflow/utils` package to use the `parseDurationToDate` function
- Updated examples in documentation to show proper usage with:
- Duration strings (e.g., "5m", "30s")
- Millisecond values (e.g., 5000 for 5 seconds)
- Date objects
### How to test?
1. Create a workflow that uses `RetryableError` with different `retryAfter` formats:
```typescript
// With milliseconds
throw new RetryableError("Test retry", { retryAfter: 5000 });
// With duration string
throw new RetryableError("Test retry", { retryAfter: "5m" });
// With Date object
throw new RetryableError("Test retry", { retryAfter: new Date(Date.now() + 10000) });
```
2. Verify that the retry behavior correctly respects the specified durations
### Why make this change?
Using milliseconds as the unit for numeric time values is more consistent with JavaScript conventions (like `setTimeout` and other timing functions). This change makes the API more intuitive for JavaScript developers and aligns with standard practices in the ecosystem.
Signed-off-by: Nathan Rajlich <n@n8.io >
2025-11-06 13:42:59 -08:00
a28bc37e35
Make @standard-schema/spec be a regular dependency ( #231 )
...
* Make `@standard-schema/spec` be a regular dependency
The Standard Schema docs explicitly say that it should be a regular dep,
not a dev dep: https://standardschema.dev/#can-i-add-it-as-a-dev-dependency
* Support input/output types
2025-11-05 12:59:12 -08:00
5c0268b8a4
feat: Add Standard Schema support and runtime validation to defineHook() ( #144 )
...
Signed-off-by: Roman Popov <atfpom4h@gmail.com >
2025-11-05 12:07:11 -08:00
9f56434631
Make getWritable work inside steps ( #222 )
2025-11-05 09:54:13 -08:00
5b9a24a6bf
[docs] Remove framework support callout ( #220 )
2025-11-04 23:07:31 -08:00
d792ff5063
Fix CLI flag documentation: --auth-token → --authToken ( #213 )
2025-11-04 16:09:55 -08:00
f809294049
docs: invalid example for inspect example ( #188 )
...
Signed-off-by: Paul Nodet <5941125+pnodet@users.noreply.github.com >
2025-11-04 12:22:01 -08:00
9a5d5a1f32
Updated postgres world doc ( #178 )
...
Removed Duplicate code snippet
2025-11-04 00:03:48 -08:00
f563585343
docs: add WorkflowReadableStreamOptions to start api reference ( #100 )
...
* export WorkflowReadableStreamOptions from workflow/api
* docs: add WorkflowReadableStreamOptions to start api reference
* changeset
* docs: update getRun api reference to show WorkflowReadableStreamOptions
* refactor: link to WorkflowReadableStreamOptions on getRun docs
* Apply suggestion from @TooTallNate
---------
Co-authored-by: Nathan Rajlich <n@n8.io >
2025-11-03 22:29:23 -08:00
05714f7924
feat: add sveltekit support ( #131 )
...
* add workbench sveltekit
* add sveltekit package
* fix: use js for generated server routes in svelte
* add test routes for sveltekit workbench
* updates from debugging
* feat: add sveltekit build target
* update user sign up workflow workbench sveltekit
* fix: base builder missing GET route handler for sveltekit
* feat: add vercel builder and check for vercel env
* refactor: workflowPlugin for sveltekit
* ci: add tests to workbench sveltekit
* fix: no start command and vercel builder outputs
* fix: base builder conditions
* .
* add auto adapter sveltekit
* fix: disable checking origin for cross site ci stuff
* allow all trusted origins in svelte config
* fix: add catch for error thrown when waiting for ops
* fix: sveltekit workbench adapter
* test
* test
* refactor: move vercel builder on config resolved
* update package json
* add demo workflow trigger
* test letting sveltekit handle route generation
* fix: exclude git ignore for local builder outputs
* update config
* add debug logs
* update debug
* update turbo.json
* fix env check
* another output
* use top-level await
* ensure vercel functions are patched
* change hook
* update
* fix spread
* debug
* update
* chore: remove vercel builder
* chore: update comments in sveltekit workflow package
* chore: remove console comment
* refactor: workflow svelte plugin
* refactor: simplify local builder config
* chore: remove unused deps
* chore: add comment for workbench svelte app
* chore: add sveltekit export to workflow
* export sveltekit from workflow
* lockfile
* chore: remove unused deps svelte workbench
* update styling
* add sveltekit getting started docs
* update sveltekit docs getting started
* changeset
* Apply suggestion from @vercel[bot]
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* use proper env var
* Update packages/sveltekit/src/index.ts
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* Update docs/content/docs/getting-started/sveltekit.mdx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
* Document CSRF protection bypass in SvelteKit workbench config (#157 )
* Initial plan
* docs: add CSRF security warning to svelte.config.js
Co-authored-by: adriandlam <93681064+adriandlam@users.noreply.github.com >
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com >
Co-authored-by: adriandlam <93681064+adriandlam@users.noreply.github.com >
* refactor: deduplicate SvelteKit request conversion logic (#156 )
* Initial plan
* refactor: extract duplicated SvelteKit request conversion to helper
Co-authored-by: adriandlam <93681064+adriandlam@users.noreply.github.com >
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com >
Co-authored-by: adriandlam <93681064+adriandlam@users.noreply.github.com >
* docs: fix getting staretd sveltekit missing folder
* chore: cleanup sveltekit builder after rebase
* lockfile
* fix: sveltekit building logic in base builder
* refactor: move sveltekit builder logic to its own package
* fix: console log base builder
* changeset
* test
* feat: create hmr plugin
* fix: add initial build on load
* fix: check all files for workflows and steps
* add comments for plugin todo
* remove catching error
* fix: missing context for nodejs envs causing waitUntil to fail
* fix: setting global request conext in vercel environments
---------
Co-authored-by: JJ Kasper <jj@jjsweb.site >
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com >
2025-11-03 21:15:33 -08:00
eb78bfcdf9
feat: add NestJS to the list of upcoming supported frameworks ( #175 )
...
* feat: add NestJS to the list of upcoming supported frameworks
* Update docs/app/(home)/components/frameworks.tsx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
* Update docs/app/(home)/components/frameworks.tsx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
* Update docs/app/(home)/components/frameworks.tsx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
2025-11-03 14:36:10 -08:00
f973954bd3
Switching from MIT to Apache + DCO ( #191 )
...
* Switching from MIT to Apache + DCO
* Add DCO github app
2025-11-03 12:42:40 -08:00
2e1e2f61dc
docs: remove bun getting started card and add bun install command ( #176 )
2025-10-31 22:08:30 -07:00
61f022a773
Update use-cases-server.tsx ( #173 )
2025-10-31 13:39:16 -07:00
50308ea82e
fix: docs code block styling ( #158 )
2025-10-31 13:38:03 -07:00
1223721d8c
[docs] Improve the setup instructions for @workflow/world-postgres ( #59 )
2025-10-30 10:11:10 -07:00
ec8b503352
Fix DurableAgent bad 'use step' docs example
2025-10-29 15:59:04 -07:00
9e0f7b0e0d
Add DurableAgent and WorkflowChatTransport doc pages ( #44 )
...
Co-authored-by: Adrian <me@adriandlam.com >
2025-10-28 23:45:42 -07:00
5fce21922a
docs: update next logo and fix animating logos on landing ( #122 )
...
* docs: update next logo and fix animating logos on landing
* fix: kebab case on attributes in docs nextjs logo
2025-10-28 17:41:02 -07:00
0f845afb2a
Alias workflow web to workflow inspect runs --web, update o11y doc image, hide trace viewer search for small runs ( #124 )
2025-10-28 17:19:39 -07:00
302d0552ec
fix: correct proxy regex from Workflow docs setup ( #114 )
...
Fixes unbalanced regex pattern in proxy.ts matcher for Workflow setup documentation, resolving "Invalid source: Unbalanced pattern" error on dev server startup.
2025-10-28 17:01:21 -07:00
88d0cfd5f8
docs: reorder templates in getting started ( #121 )
2025-10-28 16:52:21 -07:00
08ed58b060
Update withWorkflow and update docs ( #123 )
2025-10-28 14:18:33 -07:00
f0c8562504
docs: fix nested a tags in tsdoc comp ( #102 )
...
* docs: fix nested a tags in tsdoc comp
* docs: fix primary a tag color in api reference table
2025-10-28 12:50:11 -07:00
25b8e882ff
docs: add hono getting started page ( #107 )
...
* docs: add hono getting started page
* Update docs/content/docs/getting-started/hono.mdx
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
* docs: add template nodejs to hono create command
* Update docs/content/docs/getting-started/hono.mdx
Co-authored-by: Pooya Parsa <pyapar@gmail.com >
* docs: add callout for nitro
* docs: update getting started nitro callout
* Update docs/content/docs/getting-started/hono.mdx
Co-authored-by: Pooya Parsa <pyapar@gmail.com >
---------
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: Pooya Parsa <pyapar@gmail.com >
2025-10-28 12:38:23 -07:00
a27a0b316d
Make serving LLMs to agents actually work and give them an index to navigate ( #108 )
...
- The original code was rewriting in the wrong phase and with the wrong regex for Claude
- I noticed that LLMs need a way to discover other pages efficiently, so I made a sitemap in markdown and linked it from every MD page at the bottom
2025-10-27 17:57:49 -07:00
50b6061272
docs: Fix capitalization for IntelliSense & TypeScript ( #103 )
2025-10-27 15:53:01 -07:00
6504e4285c
Add bigint serialization support ( #90 )
2025-10-27 15:51:39 -07:00
7bb7486d40
Docs Page on "Understanding Directives" ( #89 )
...
* Draft of Why Directives post
* Fix link
* Improvements
* Vercel comment fixes
* More grammar/flow/style fixes
* Rename to understanding directives
* fixes
2025-10-27 12:49:16 -07:00
b301b0a557
Add callout to directives guide ( #75 )
2025-10-26 09:50:51 -07:00
109abcfbbc
Fix typo in use cases ( #78 )
2025-10-26 09:50:15 -07:00
e2889cd5f2
SEO improvements ( #87 )
2025-10-26 09:37:31 -07:00
b4d1a8de37
Docs: Small improvements to the How it works pages
2025-10-25 21:00:30 -07:00
Adrian