DX-2363: add workflow-js skills #175
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive TypeScript documentation for the Upstash Workflow SDK under the "skills" directory. The documentation covers all aspects of working with workflows including basic APIs, advanced features, troubleshooting guides, migration paths, and agent orchestration patterns.
Changes:
- Added main skill index file (SKILL.md) that organizes and references all documentation
- Added comprehensive guides covering basics (serve, context, client), features (invoke, flow-control, retries, webhooks, wait-for-event), how-to guides (local-dev, middleware, migrations, realtime), troubleshooting, REST API reference, and agents documentation
- Created a structured documentation system to help developers understand and implement Upstash Workflow patterns
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/SKILL.md | Main index organizing all workflow documentation with quick start example |
| skills/troubleshooting.md | Common workflow issues, debugging patterns, and solutions for TypeScript |
| skills/rest-api.md | REST API reference for DLQ operations and workflow management |
| skills/agents.md | Guide for building multi-agent workflows with tools and orchestration patterns |
| skills/basics/serve.md | Documentation for exposing workflows as HTTP endpoints |
| skills/basics/context.md | Complete reference for workflow context API methods |
| skills/basics/client.md | Client API for triggering, canceling, and managing workflow runs |
| skills/features/invoke.md | Cross-workflow invocation and serveMany patterns |
| skills/features/flow-control.md | Rate limiting and concurrency control documentation |
| skills/features/retries-failures-reliability.md | Comprehensive reliability features including DLQ and failure handling |
| skills/features/wait-for-event.md | Event-driven workflow patterns with notify/wait |
| skills/features/webhooks.md | Webhook creation and consumption in workflows |
| skills/how-to/local-dev.md | Local development setup with QStash dev server and ngrok |
| skills/how-to/middleware.md | Custom middleware creation for lifecycle and debug events |
| skills/how-to/migrations.md | Migration guide between workflow SDK versions |
| skills/how-to/realtime.md | Real-time workflow integration with Upstash Realtime |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.