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

[samejr]

• Adds a new waitpoint token page in the docs
• Removes old wait-for coming soon pages
• Updates the app blank state copy for waitpoint tokens
• LInks the app blank state docs URL to the new waitpoint tokens page
• Adds a temporary "upgrade to v4" docs page

Summary by CodeRabbit

• New Features

  • Updated interface elements now provide a clearer explanation of waitpoint tokens, emphasizing their role in pausing task execution until confirmation is received.

• Documentation

  • Revised documentation now directs users to the updated waitpoint token page.
  • Outdated resources have been removed, and new content has been added, including guidance on upgrading to version 4 and updated wait mechanism details.

[changeset-bot]

⚠️ No Changeset found

Latest commit: ba547bd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request updates both the UI and documentation related to waiting mechanisms for tasks. The changes in the web application update the navigation link and accompanying text within the blank state panels, directing users to updated documentation. In the documentation, outdated pages and function references have been removed and replaced with new entries that emphasize waitpoint tokens, along with a streamlined table describing waiting functions. A new upgrade guide for version 4 has also been introduced.

Changes

File(s)	Change Summary
apps/webapp/app/components/BlankStatePanels.tsx	Updated the NoWaitpointTokens function: revised accessory text and updated the LinkButton's to prop to use docsPath("wait-for-token"), with consolidated paragraph content.
docs/docs.json, docs/wait.mdx	Modified documentation navigation: replaced pages/functions (wait-for-event, wait-for-request and their functions) with wait-for-token entries and updated the documentation table accordingly.
docs/upgrade-to-v4.mdx, docs/wait-for-token.mdx	Introduced new documentation files: added an upgrade guide for version 4 and a new page explaining waitpoint tokens.
docs/wait-for-event.mdx, docs/wait-for-request.mdx	Removed outdated documentation files related to waiting for events and requests.

Possibly related PRs

• Docs/more docs improvements #1718: Changes related to the wait-for-token documentation and updates to the NoWaitpointTokens function indicate a direct connection in documentation updates.
• Fixes a docs link and tweaks some wording for the triggering task blank state #1856: Updates to LinkButton properties and documentation links align with these changes.
• Changes frozen to waiting #1551: Adjustments to waiting mechanism terminology and functions complement this PR's modifications.

Suggested reviewers

• nicktrn

Poem

I'm a rabbit, hopping through the code,
Making changes where the tokens showed.
Links now lead to clearer light,
Guiding users from day to night.
With docs renewed and paths well-set,
I celebrate this code-bunny duet!
Hop along, enjoy the ride! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61b85f8 and ba547bd.

📒 Files selected for processing (1)

• docs/upgrade-to-v4.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/upgrade-to-v4.mdx

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: typecheck / typecheck
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: Analyze (javascript-typescript)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/wait-for-token.mdx (1)

1-10: Good introduction to waitpoint tokens.

This page provides a clear and concise explanation of waitpoint tokens and their primary use cases. The inclusion of the ComingSoon component indicates that more detailed documentation is planned.

Consider expanding this documentation in the future with:

• Code examples showing how to implement waitpoint tokens
• Screenshots of the UI for managing tokens
• Best practices for token-based workflows

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a5b9151 and 61b85f8.

📒 Files selected for processing (7)

• apps/webapp/app/components/BlankStatePanels.tsx (1 hunks)
• docs/docs.json (1 hunks)
• docs/upgrade-to-v4.mdx (1 hunks)
• docs/wait-for-event.mdx (0 hunks)
• docs/wait-for-request.mdx (0 hunks)
• docs/wait-for-token.mdx (1 hunks)
• docs/wait.mdx (1 hunks)

💤 Files with no reviewable changes (2)

• docs/wait-for-request.mdx
• docs/wait-for-event.mdx

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (5)

docs/upgrade-to-v4.mdx (1)

1-8: LGTM for the placeholder page.

This page serves as a good placeholder for the upcoming v4 upgrade documentation. The warning note clearly indicates that more detailed content is forthcoming.

docs/docs.json (1)

43-43: Correctly updated documentation navigation structure.

The navigation has been properly updated to include the new "wait-for-token" page and remove the older pages. This aligns with the PR objective of enhancing the documentation for waitpoint tokens.

docs/wait.mdx (1)

13-17: Successfully updated the waiting functions table.

The table has been properly updated to include the new wait.forToken() function while removing the deprecated functions. The formatting is clean and consistent with the rest of the documentation.

apps/webapp/app/components/BlankStatePanels.tsx (2)

422-422: Correctly updated docs link to point to the new waitpoint token page.

The link has been properly updated to point to the new waitpoint token documentation page instead of the general wait page, improving the user experience by connecting users with more specific and relevant information.

---

428-430: Improved description of waitpoint tokens.

The updated description clearly explains what waitpoint tokens are and their common use cases, particularly for approval workflows and human-in-the-loop processes. The text is now more focused and informative than the previous version.