Skip to content

New waitpoint token docs page + updates the URL and description for the waitpoint blank state in the app #1860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 1, 2025
Merged

New waitpoint token docs page + updates the URL and description for the waitpoint blank state in the app #1860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18c9a9b
Delete old wait-for pages & create new wait-for-token page
samejr Apr 1, 2025
67bbf71
Link to new wait-for-token page and update description
samejr Apr 1, 2025
61b85f8
Adds an upgrade to v4 coming soon docs page
samejr Apr 1, 2025
ba547bd
Removes unncessary property from Note component
samejr Apr 1, 2025
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions docs/wait-for-request.mdx
View file
Open in desktop

This file was deleted.

10 changes: 10 additions & 0 deletions docs/wait-for-token.mdx
View file
Open in desktop
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
View file
Open in desktop
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