Docs - add vercel redirects

[andrewjschuang]

WHY

Summary by CodeRabbit

• Documentation
  • Revised content by removing outdated introductory summaries and visual metadata to simplify the layout.
  • Fixed link formatting issues to ensure accurate navigation and a cleaner reading experience.
• Chores
  • Updated URL redirect configurations to improve the organization and accessibility of the documentation.

These refinements enhance consistency and streamline access to information for an improved user experience.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 21, 2025 3:05pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Feb 21, 2025 3:05pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Feb 21, 2025 3:05pm

[coderabbitai]

Walkthrough

The pull request removes specific metadata from the Node.js workflow documentation file and corrects a link formatting issue. In addition, the vercel.json file has been updated with new redirect rules by modifying paths, removing obsolete notebook entries, and adding new routes to restructure documentation access. There are no changes to any exported or public entities.

Changes

File	Change Summary
docs-v2/.../working-with-files.mdx	Removed the short_description and thumbnail metadata; corrected the link syntax by removing an extra closing parenthesis.
docs-v2/vercel.json	Modified redirect rules: updated trailing slashes in multiple paths, removed outdated /docs/notebook entries, and introduced new redirects for improved structure.

Suggested reviewers

• dylburger

Poem

Hoppity-hop, I scurry with cheer,
Trimming metadata, the docs look clear.
Redirects reflow like a gentle stream,
Shaping new paths, just as in a dream.
A bunny’s delight in every line and beam! 🐇✨

---

📜 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 fde1d83 and 130165b.

📒 Files selected for processing (2)

• docs-v2/pages/workflows/building-workflows/code/nodejs/working-with-files.mdx (1 hunks)
• docs-v2/vercel.json (3 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs-v2/pages/workflows/building-workflows/code/nodejs/working-with-files.mdx

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

• GitHub Check: Lint Code Base
• GitHub Check: validate-links

🔇 Additional comments (22)

docs-v2/vercel.json (22)

6-15: Group 1 – Docs V3 & “what-is-pipedream” Redirects:
The changes update the redirects for /docs/v3/, /docs/v3/(.*)/, and /docs/what-is-pipedream/ to point to the new destinations. The trailing slash and regex pattern adjustments appear intentional and consistent with the new documentation structure.

---

18-31: Group 2 – Apps-related Internal Redirects (Part 1):
This block revises several paths under /docs/apps/ by mapping them to their corresponding new integrations or workflow destinations. In particular, updates for /docs/apps/, /docs/apps/app-partners/, /docs/apps/guide/requesting-additional-oauth-scopes/, and /docs/apps/contributing/ seem correctly aligned with the restructuring efforts.

---

34-39: Group 3 – Apps-related External Redirects:
The redirect for /docs/apps/all-apps/ now points to an external URL (https://pipedream.com/apps/) and the wildcard /docs/apps/(.*)/ similarly points to https://pipedream.com/apps/$1/. These changes clearly indicate a move to an external resource and are consistent with the new external navigation strategy.

---

42-59: Group 4 – Support, Security, and Quickstart Redirects:
This group updates /docs/support/, /docs/security/, /docs/user-settings/, /docs/quickstart/run-workflow-on-a-schedule/, and /docs/quickstart/github-sync/. The new destinations are internally consistent with the site’s new structure. It would be good to confirm that the new internal paths (e.g. /docs/privacy-and-security/ and /account/user-settings/) correctly reflect the updated hierarchy.

---

66-107: Group 5 – Notebook-related Redirects:
These changes revamp a series of notebook-related redirects (e.g. /docs/notebook/, /docs/notebook/actions/, /docs/notebook/fork/, /docs/notebook/inspector/, and various /docs/notebook/destinations/..., /docs/notebook/code/, and /docs/notebook/observability/). The new destinations mostly point into the workflows area of the docs. This consolidation should help users navigate to the updated workflow-centric documentation.

---

110-159: Group 6 – Projects, Sources & Workflow Steps:
This block covers a range of paths—from /docs/sources/ through various /docs/projects/ (including subpaths dealing with file stores) to /docs/event-history/ and workflow steps like concurrency, forks, async code, and step state/params. The adjustments map these legacy paths into the new workflows structure. Please ensure that none of these new routes conflict with preexisting routes.

---

174-187: Group 7 – Workflow Built-in Functions & Steps (Triggers/Actions):
The updates for /docs/workflows/built-in-functions/, /docs/workflows/events/inspect/, /docs/workflows/steps/triggers/, and /docs/workflows/steps/actions/ now point to the corresponding “building-workflows” sections. These changes help standardize the workflow documentation.

---

190-195: Group 8 – Flow Control and Networking Redirects:
The new redirect for /docs/workflows/flow-control/ to /docs/workflows/building-workflows/control-flow/ is clear. However, note that the updated redirect for /docs/workflows/networking/ (lines 194-195) now points to /docs/workflows/data-management/databases/—which is different from the existing (unchanged) entry earlier in the file that maps /docs/workflows/networking/ to /docs/workflows/vpc/. Please verify that having two entries with the same source is intentional and that the order of these rules yields the desired behavior.

---

198-207: Group 9 – Workflows & Code Organization:
The redirect for /docs/workflows/(.*)/ now directs calls into the /docs/workflows/building-workflows/ namespace. Additionally, /docs/code/ and its wildcard variant are now mapped to /docs/workflows/building-workflows/code/. This shift reinforces a more unified code and workflow documentation structure.

---

210-215: Group 10 – HTTP & Environment Variables:
The changes standardize /docs/http/ and /docs/environment-variables/ by routing them under the building-workflows umbrella. The new structure should aid in user comprehension.

---

218-227: Group 11 – Components Redirects:
Updates for /docs/components/quickstart/nodejs/actions/, /docs/components/, and /docs/components/(.*)/ now direct users to the components section within workflows/contributing. This consolidation is consistent with the documentation reorganization.

---

230-235: Group 12 – GitHub Sync & Workspaces (Part 1):
The redirect for /docs/github-sync/ now points to /docs/workflows/git/, and /docs/workspaces/ is now redirected to /docs/workflows/workspaces/. This ensures that legacy workspace references are properly modernized alongside GitHub sync documentation.

---

238-247: Group 13 – Workspaces SSO Redirects:
The changes for /docs/workspaces/okta/, /docs/workspaces/google/, and /docs/workspaces/saml/ now route users to their respective SSO sections under workspaces. This clarification should improve SSO-related navigation across different identity providers.

---

250-259: Group 14 – Workspaces & Pricing FAQs:
Here, the redirect for /docs/workspaces/(.*)/ is consolidated to /docs/workflows/workspaces/$1/ and the FAQ and pricing anchors have been updated. These tweaks further streamline the user journey between workspaces and pricing details.

---

262-270: Group 15 – Connected Accounts Redirects:
This section revises the paths related to connected accounts. The redirect for /docs/connected-accounts/api/ now goes to /docs/connect/api/#accounts/ while the base and wildcard routes direct to /docs/integrations/connected-accounts/. The updated targets reflect a clearer integration with the overall documentation structure.

---

274-279: Group 16 – API to REST API Reorganization:
The modifications redirect /docs/api/ and its wildcard version to /docs/rest-api/ respectively. This change simplifies and clarifies the API documentation, likely reflecting a rebranding from “API” to “REST API.”

---

282-291: Group 17 – Data Stores & Databases:
These changes align /docs/data-stores/ and /docs/databases/ (including the wildcard version) with a new data-management hierarchy inside workflows. This reorganization should make it easier for users to locate and understand the database-related documentation.

---

294-295: Group 18 – CLI Redirect:
The /docs/cli/(.*)/ redirect now maps to /docs/workflows/cli/reference/$1/, which reinforces the new documentation structure.

---

306-311: Group 19 – Connect Customization Redirects (Part 1):
This update directs /docs/connect/connect-link/ and /docs/connect/customize-your-app/ to their new destinations under /docs/connect/managed-auth/. These changes should provide clearer guidance on using connect features.

---

314-319: Group 20 – Connect OAuth & Quickstart:
The redirects for /docs/connect/oauth-clients/ and /docs/connect/quickstart/ have been updated to fall under the managed-auth section. This consolidation helps users find OAuth client management and quickstart guides in a centralized location.

---

322-327: Group 21 – Connect Tokens & Webhooks:
The updates for /docs/connect/tokens/ and /docs/connect/webhooks/ now map into the managed-auth structure. This aligns token and webhook information with other authentication-related documentation.

---

330-331: Group 22 – Connect OAuth Client Customization:
The final update adjusts the anchor for /docs/connect/oauth-clients#using-your-own-oauth-client to include a clearer URL structure (/docs/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client). This precise update ensures that in-page navigation and anchor linking operate as expected.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.