Docs - remove /docs from destinations

[andrewjschuang]

WHY

Summary by CodeRabbit

• Documentation
  • Streamlined documentation page URLs by removing redundant path segments, resulting in a more direct and accessible navigation experience for end-users.

[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 4:04pm

2 Skipped Deployments

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

[coderabbitai]

Walkthrough

This pull request modifies the vercel.json configuration by removing the /docs prefix from various destination URLs in the redirects section. The changes update the destination paths to point directly to the intended sections (e.g., updating /docs/v3/ to / and /docs/integrations/apps/ to /integrations/apps/), streamlining the URL structure for improved clarity. There are no changes to the declared exported or public entities.

Changes

File	Change Summary
docs-v2/vercel.json	Removed /docs prefix from multiple redirect destination URLs (e.g., /docs/v3/ → /, /docs/integrations/apps/ → /integrations/apps/), streamlining the URL structure.

Possibly related PRs

• Fix docs v3 redirects #13949: Addresses similar removal of /docs/v3 redirects in the vercel.json file.
• Docs - add vercel redirects #15689: Also updates redirect rules in vercel.json to simplify documentation paths.
• Various Connect docs updates #14990: Involves changes to redirect rules for connect quickstart documentation, related to the adjustments in the current PR.

Suggested labels

User submitted

Suggested reviewers

• dylburger

Poem

I'm a rabbit, hopping in code so free,
Trimming paths with a bounce of glee.
The /docs prefix is now out of sight,
Guiding URLs calmly into the light.
With a joyful hop in every byte,
I celebrate our changes day and night!

---

📜 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 5e9be67 and 28b6e0a.

📒 Files selected for processing (1)

• docs-v2/vercel.json (2 hunks)

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

• GitHub Check: Lint Code Base

🔇 Additional comments (23)

docs-v2/vercel.json (23)

6-32: Documentation Redirects Update – v3 & Apps Section
The destination paths for the /docs/v3/ and various /docs/apps/... routes have been updated by removing the /docs prefix. For example, the /docs/v3/ entry now redirects to / and the apps-related endpoints have been updated to reflect new base paths (e.g. /integrations/apps/, /integrations/app-partners/, etc.). Please verify that these new destinations align precisely with the updated documentation structure.

---

45-64: Documentation Redirects Update – Security, Quickstart & Cron
The updated redirect entries for /docs/security/, /docs/quickstart/run-workflow-on-a-schedule/, /docs/quickstart/github-sync/, and /docs/cron/ now point to shorter, more streamlined destinations (e.g. /privacy-and-security/, /quickstart/, /workflows/git/, and /workflows/building-workflows/triggers/). Ensure that these new routes correctly reflect the desired user experience and URL hierarchy.

---

66-104: Documentation Redirects Update – Notebook Section (Part 1)
The redirection paths for several notebook-related routes (including /docs/notebook/, /docs/notebook/actions/, /docs/notebook/fork/, /docs/notebook/inspector/) have been modified to point into the /workflows/... hierarchy. These changes appear consistent. Please double-check that any regex-based substitutions (e.g. in /docs/notebook/destinations/(.*)/) correctly capture and rebuild the intended URL segments.

---

106-132: Documentation Redirects Update – Notebook SQL & Projects Section
The redirect for /docs/notebook/sql/ (now pointing to a working-with-sql page) and the project-related entries (/docs/projects/, /docs/projects/git/, /docs/projects/file-stores/, etc.) have been updated to remove the /docs prefix. Be sure that the regex capture groups (e.g. in /docs/projects/(.*)/) yield the expected results during redirection.

---

134-156: Documentation Redirects Update – Event History & Initial Workflows
Redirects for /docs/event-history/, /docs/workflows/concurrency-and-throttling/, /docs/workflows/steps/, /docs/workflows/fork/, /docs/workflows/steps/code/async/, and /docs/workflows/steps/code/state/ now point to their new destinations. Note the use of hash anchors (like /#steps and /#step-exports); please confirm that these anchors are correctly handled in the new URL structure.

---

158-184: Documentation Redirects Update – Workflows Details (Part 2)
The redirect entries for /docs/workflows/steps/params/, /docs/workflows/events/cold-starts/, /docs/workflows/examples/waiting-to-execute-next-step-of-workflow/, /docs/workflows/networking/, /docs/workflows/built-in-functions/, /docs/workflows/events/inspect/, and /docs/workflows/steps/triggers/ have been streamlined. These modifications remove the /docs prefix and reorganize URLs under the /workflows/building-workflows/… hierarchy. Please test these mappings to ensure that dynamic segments and paths function as expected.

---

186-200: Documentation Redirects Update – Workflows Actions & Flow-Control
The workflow-related redirects for /docs/workflows/steps/actions/, /docs/workflows/flow-control/, /docs/workflows/networking/ (again, but now targeting databases) and /docs/workflows/(.*)/ have been updated. The dynamic capture groups (e.g. $1) must be validated to ensure they inject the correct URL segments at runtime.

---

202-212: Documentation Redirects Update – Code & HTTP Sections
The /docs/code/ routes (both the base path and those with capture groups) as well as /docs/http/ have been remapped to directories under /workflows/building-workflows/code/ and /workflows/building-workflows/http/. These changes are straightforward; please verify that the updated paths are correct relative to the deployment configuration.

---

214-224: Documentation Redirects Update – Environment Variables & Components (Part 1)
The redirect for /docs/environment-variables/ now points to /workflows/environment-variables/, and the quickstart actions for components have been updated accordingly. These modifications remove the redundant /docs segment and help in clarifying the URL structure.

---

226-232: Documentation Redirects Update – Components & GitHub Sync
The entry for /docs/components/(.*)/ now redirects to /workflows/contributing/components/$1/ and /docs/github-sync/ now points to /workflows/git/. Please validate that the dynamic substitution works as intended and that these destinations meet the documentation’s updated organization.

---

234-244: Documentation Redirects Update – Workspaces (Part 1)
Redirects for workspace-related routes (e.g. /docs/workspaces/, /docs/workspaces/okta/, /docs/workspaces/google/) have been updated to reside under /workflows/workspaces/ and its subdirectories. The new structure appears to mirror the intended navigation improvements—please double-check these against the current documentation layout.

---

246-252: Documentation Redirects Update – Workspaces (Part 2)
The modifications for /docs/workspaces/saml/ and /docs/workspaces/(.*)/ remove the /docs prefix and standardize the destination under /workflows/workspaces/. Ensure that any dynamic segments captured by (.*) are properly routed.

---

254-260: Documentation Redirects Update – Pricing Section
The redirect for /docs/workspaces-and-credits-faq/ has been updated to /pricing/faq/ and /docs/pricing/#developer-tier now points to /pricing/#free-tier. These cleaner URLs should help users, but please verify that the hashtag anchors continue to work as expected.

---

262-272: Documentation Redirects Update – Connected Accounts (Part 1)
The changes for /docs/connected-accounts/api/, /docs/connected-accounts/, and /docs/connected-accounts/(.*)/ now redirect to /connect/api/#accounts/ and /integrations/connected-accounts/ paths. These updates are consistent with the removal of the /docs prefix; a quick functional check to confirm correct redirection is advised.

---

274-280: Documentation Redirects Update – API Section
The updates for /docs/api/ and /docs/api/(.*)/ now lead to /rest-api/ endpoints. These changes are clear and help in reducing URL verbosity. Ensure that all API documentation links resolve correctly.

---

282-292: Documentation Redirects Update – Data Stores & Databases
For the data stores and databases sections, the redirects have been updated to remove /docs and now fall under /workflows/data-management/…. Pay special attention to the regex capture group in the databases path (/docs/databases/(.*)/) to ensure it returns the correct subpath.

---

294-296: Documentation Redirects Update – CLI Section
The redirect for /docs/cli/(.*)/ now points to /workflows/cli/reference/$1/, which looks appropriate. This change is straightforward, but a quick check on the target documentation reference is recommended.

---

298-304: Documentation Redirects Update – Connect Quickstart
The entries for /docs/connect/quickstart#use-connect-link and /docs/connect/quickstart#connect-a-users-account now map to paths with hash anchors under /connect/managed-auth/quickstart/. Please verify that these fragment identifiers (anchors) are correctly preserved and that the redirections behave properly in the final deployment.

---

306-312: Documentation Redirects Update – Connect Customization
The changes for /docs/connect/connect-link/ and /docs/connect/customize-your-app/ have been updated to their new destinations under /connect/managed-auth/. The adjustments look consistent with the overall refactoring effort.

---

314-320: Documentation Redirects Update – Connect OAuth & Quickstart
The redirect entries for /docs/connect/oauth-clients/ and /docs/connect/quickstart/ now point to /connect/managed-auth/oauth-clients/ and /connect/managed-auth/quickstart/, respectively. These changes should streamline access for users; please confirm that any downstream integrations are updated accordingly.

---

321-324: Documentation Redirects Update – Connect Tokens
The /docs/connect/tokens/ redirect now points to /connect/managed-auth/tokens/. This adjustment is minimal and appears correct—just verify its behavior in the environment.

---

326-328: Documentation Redirects Update – Connect Webhooks
The entry for /docs/connect/webhooks/ has been updated to /connect/managed-auth/webhooks/, which matches the new managed-auth URL scheme.

---

330-332: Documentation Redirects Update – Connect OAuth Clients (Customized)
The last redirect updates /docs/connect/oauth-clients#using-your-own-oauth-client to include an anchor in the new destination. Please verify that the custom OAuth client instructions are accurately accessible under the new URL.

---

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.