Skip to content

Commit 551b794

Browse files
authored
New waitpoint token docs page + updates the URL and description for the waitpoint blank state in the app (#1860)
* Delete old wait-for pages & create new wait-for-token page * Link to new wait-for-token page and update description * Adds an upgrade to v4 coming soon docs page * Removes unncessary property from Note component
1 parent a5b9151 commit 551b794

File tree

7 files changed

+26
-27
lines changed

7 files changed

+26
-27
lines changed

apps/webapp/app/components/BlankStatePanels.tsx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -419,17 +419,15 @@ export function NoWaitpointTokens() {
419419
iconClassName="text-sky-500"
420420
panelClassName="max-w-md"
421421
accessory={
422-
<LinkButton to={docsPath("wait")} variant="docs/small" LeadingIcon={BookOpenIcon}>
422+
<LinkButton to={docsPath("wait-for-token")} variant="docs/small" LeadingIcon={BookOpenIcon}>
423423
Waitpoint docs
424424
</LinkButton>
425425
}
426426
>
427427
<Paragraph spacing variant="small">
428-
Waitpoint tokens are used to pause runs until you complete the token so the run can
429-
continue.
430-
</Paragraph>
431-
<Paragraph spacing variant="small">
432-
You can build approval workflows using them, as well as other use cases.
428+
Waitpoint tokens pause task runs until you complete the token. They're commonly used for
429+
approval workflows and other scenarios where you need to wait for external confirmation,
430+
such as human-in-the-loop processes.
433431
</Paragraph>
434432
</InfoPanel>
435433
);

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"errors-retrying",
4141
{
4242
"group": "Wait",
43-
"pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
43+
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
4444
},
4545
"queue-concurrency",
4646
"versioning",

docs/upgrade-to-v4.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Upgrading to v4"
3+
description: "How to upgrade to v4."
4+
---
5+
6+
<Note>
7+
Upgrading to v4 docs are coming soon.
8+
</Note>

docs/wait-for-event.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/wait-for-request.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/wait-for-token.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Wait for token"
3+
description: "Wait until a token is completed."
4+
---
5+
6+
import ComingSoon from "/snippets/coming-soon-generic.mdx"
7+
8+
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.
9+
10+
<ComingSoon />

docs/wait.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ Waiting allows you to write complex tasks as a set of async code, without having
1010

1111
<PausedExecutionFree />
1212

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

0 commit comments

Comments
 (0)