Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions apps/webapp/app/components/BlankStatePanels.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -419,17 +419,15 @@ export function NoWaitpointTokens() {
iconClassName="text-sky-500"
panelClassName="max-w-md"
accessory={
<LinkButton to={docsPath("wait")} variant="docs/small" LeadingIcon={BookOpenIcon}>
<LinkButton to={docsPath("wait-for-token")} variant="docs/small" LeadingIcon={BookOpenIcon}>
Waitpoint docs
</LinkButton>
}
>
<Paragraph spacing variant="small">
Waitpoint tokens are used to pause runs until you complete the token so the run can
continue.
</Paragraph>
<Paragraph spacing variant="small">
You can build approval workflows using them, as well as other use cases.
Waitpoint tokens pause task runs until you complete the token. They're commonly used for
approval workflows and other scenarios where you need to wait for external confirmation,
such as human-in-the-loop processes.
</Paragraph>
</InfoPanel>
);
Expand Down
2 changes: 1 addition & 1 deletion docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"errors-retrying",
{
"group": "Wait",
"pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
},
"queue-concurrency",
"versioning",
Expand Down
8 changes: 8 additions & 0 deletions docs/upgrade-to-v4.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Upgrading to v4"
description: "How to upgrade to v4."
---

<Note>
Upgrading to v4 docs are coming soon.
</Note>
8 changes: 0 additions & 8 deletions docs/wait-for-event.mdx

This file was deleted.

8 changes: 0 additions & 8 deletions docs/wait-for-request.mdx

This file was deleted.

10 changes: 10 additions & 0 deletions docs/wait-for-token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Wait for token"
description: "Wait until a token is completed."
---

import ComingSoon from "/snippets/coming-soon-generic.mdx"

Waitpoint tokens pause task runs until you complete the token. They're commonly used for approval workflows and other scenarios where you need to wait for external confirmation, such as human-in-the-loop processes.

<ComingSoon />
7 changes: 3 additions & 4 deletions docs/wait.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ Waiting allows you to write complex tasks as a set of async code, without having

<PausedExecutionFree />

| Function | What it does |
| ----------------------------------------- | ----------------------------------------------------------------------------------------- |
| Function | What it does |
| :--------------------------------------| :---------------------------------------------------------------------------------------- |
| [wait.for()](/wait-for) | Waits for a specific period of time, e.g. 1 day. |
| [wait.until()](/wait-until) | Waits until the provided `Date`. |
| [wait.forRequest()](/wait-for-request) | Waits until a matching HTTP request is received, and gives you the data to continue with. |
| [waitForEvent()](/wait-for-event) | Waits for a matching event, like in the example above. |
| [wait.forToken()](/wait-for-token) | Pauses task runs until a token is completed. |
Loading