95e292e0c1
Refresh the Workflow SDK README ( #3357 )
...
* docs: refresh Workflow SDK README
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: fix README deployment link
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: restore bug bounty guidance
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: tighten README copy
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: clarify workflow suspension copy
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: add code of conduct
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* docs: remove README workflow example
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* Apply suggestions from code review
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Signed-off-by: Mitul Shah <mitulxshah@gmail.com >
* docs: restore security disclosure wording
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
* Apply suggestions from code review
Co-authored-by: Mitul Shah <mitulxshah@gmail.com >
Signed-off-by: Mitul Shah <mitulxshah@gmail.com >
---------
Signed-off-by: Cursor Agent <cursoragent@cursor.com >
Signed-off-by: Mitul Shah <mitulxshah@gmail.com >
Co-authored-by: Cursor Agent <cursoragent@cursor.com >
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
2026-08-05 14:59:11 -07:00
e8934ade9c
Remove self-attribution from README ( #3182 )
...
Signed-off-by: Douglas Harcourt Parsons <dglsparsons@users.noreply.github.com >
2026-07-29 10:28:11 -07:00
173756dc4d
[docs] Rename workflowdevkit to workflowsdk and useworkflow.dev to workflow-sdk.dev ( #1759 )
...
* [docs] Rename workflowdevkit references to workflowsdk
* [docs] Rename useworkflow.dev to workflow-sdk.dev
* [chore] Add changeset for domain rename
* [docs] Revert sitemap rewrite to useworkflow.dev (crawled-sitemap not yet available for new domain)
2026-04-15 18:01:48 -07:00
7e33c62736
Rename 'Workflow Development Kit' / 'DevKit' to 'Workflow SDK' ( #1595 )
...
* Rename 'Workflow Development Kit' / 'DevKit' to 'Workflow SDK' across docs, code, and config
Follow-up to cdf90d5a38#1541 )
* Fix missing </h1> closing tag and add article 'the' before 'Workflow SDK' in docs
2026-04-02 19:39:02 +00:00
cdf90d5a38
Rename Workflow DevKit to Workflow SDK, remove beta badge, add tweet wall ( #1541 )
...
* Rename Workflow DevKit to Workflow SDK, remove beta badge, add tweet wall
- Rename "Workflow DevKit" to "Workflow SDK" across all files (~108 files)
- Rename standalone "WDK" references to "Workflow SDK"
- Remove beta badge from homepage hero
- Add tweet wall component to homepage with 4 builder testimonials
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com >
* Rename Workflow DevKit to Workflow SDK, remove beta badge, add tweet wall
- Rename "Workflow DevKit" to "Workflow SDK" across all files (~108 files)
- Rename standalone "WDK" references to "Workflow SDK"
- Remove beta badge from homepage hero
- Add tweet wall component to homepage with 4 builder testimonials
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com >
Signed-off-by: Harpreet Arora <harpreet.txt@gmail.com >
* Address review: fix missed trigger phrase renames and bump skill versions
- Rename "workflow devkit" to "workflow sdk" in trigger phrases for both skill files
- Bump workflow-init SKILL.md version to 1.1
- Bump workflow SKILL.md version to 1.5
- Note: CLAUDE.md is a symlink to AGENTS.md, already renamed
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com >
Signed-off-by: Harpreet Arora <harpreet.txt@gmail.com >
* link correct tweet
---------
Signed-off-by: Harpreet Arora <harpreet.txt@gmail.com >
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com >
Co-authored-by: Karthik Kalyanaraman <karthik.kalyanaraman@vercel.com >
2026-03-29 16:05:39 -07:00
795c0f38e7
Update README.md ( #601 )
2025-12-12 23:44:26 -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
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
7dad974e21
Fix README links
2025-10-23 08:59:15 -07:00
e15dcb36eb
Fix README typo
2025-10-23 08:55:16 -07:00
4ca9a3edbd
Introducing Workflow DevKit
...
build durable, resilient, and observable workflows.
Co-authored-by: Nathan Rajlich <n@n8.io >
Co-authored-by: Pranay Prakash <pranay.gp@gmail.com >
Co-authored-by: Adrian <me@adriandlam.com >
Co-authored-by: JJ Kasper <jj@jjsweb.site >
Co-authored-by: Vercel Release Bot <88769842+vercel-release-bot@users.noreply.github.com >
Co-authored-by: Peter Wielander <mittgfu@gmail.com >
Co-authored-by: Hayden Bleasel <hello@haydenbleasel.com >
Co-authored-by: Gal Schlezinger <gal@spitfire.co.il >
Co-authored-by: Manuel Muñoz Solera <mamuso@mamuso.net >
Co-authored-by: Garrett <garrett.tolbert@vercel.com >
Co-authored-by: Lars Grammel <lars.grammel@gmail.com >
Co-authored-by: Pooya Parsa <pyapar@gmail.com >
Co-authored-by: Tom Dale <tom@tomdale.net >
Co-authored-by: Vishal Yathish <135551666+visyat@users.noreply.github.com >
Co-authored-by: josh <144584931+dancer@users.noreply.github.com >
2025-10-23 12:07:52 +03:00
Mitul Shah