Docs directory changes and sitemap gen #16349
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis set of changes reorganizes and updates internal documentation links throughout the codebase to reflect a new structure for major documentation categories such as "apps", "components", "projects", and "workspaces". Numerous markdown files were updated to correct and unify internal URLs, ensuring consistency with the new paths. Navigation metadata and configuration files were adjusted to match the updated structure, including the introduction of new redirect rules, sitemap generation configuration, and updates to navigation objects. Additionally, a new dependency and build script for sitemap generation were added, and Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant NextJSApp
participant next-sitemap
participant PublicDir
User->>NextJSApp: Build documentation site
NextJSApp->>next-sitemap: Run postbuild script
next-sitemap->>PublicDir: Generate sitemap*.xml and robots.txt
Note right of PublicDir: Sitemap and robots.txt are ignored by git per .gitignore
sequenceDiagram
participant User
participant Browser
participant NextJSApp
User->>Browser: Navigate to old doc URL (e.g., /integrations/...)
Browser->>NextJSApp: Request old URL
NextJSApp-->>Browser: Respond with 308 redirect to new URL (e.g., /apps/...)
Browser->>NextJSApp: Request new URL
NextJSApp-->>Browser: Serve updated documentation page
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
docs-v2/next-sitemap.config.jsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (4)
docs-v2/pages/components/index.mdx (4)
8-8: 🛠️ Refactor suggestion
⚠️ Potential issueFix broken MDX links to Component API
The relative linkapi/#component-structureis currently broken. Update to the new API path:-[Node.js modules](api/#component-structure) +[Node.js modules](/components/contributing/api/#component-structure)Similarly adjust other in-file API anchors at lines 27, 29, and 30.
🧰 Tools
🪛 GitHub Actions: Validate MDX Links
[error] 8-8: Broken link: /components/api/#component-structure (file not found)
[error] 8-8: Broken link: /components/api/#using-npm-packages (file not found)
27-27:⚠️ Potential issueFix broken MDX link for props Interface
Change-[Trigger](api/#interface-props) +[Trigger](/components/contributing/api/#interface-props)to restore the correct link target.
🧰 Tools
🪛 GitHub Actions: Validate MDX Links
[error] 27-27: Broken link: /components/api/#interface-props (file not found)
29-29:⚠️ Potential issueFix broken MDX link for db API
Change-[built-in key-value store](api/#db) +[built-in key-value store](/components/contributing/api/#db)to prevent the broken link error.
🧰 Tools
🪛 GitHub Actions: Validate MDX Links
[error] 29-29: Broken link: /components/api/#db (file not found)
30-30:⚠️ Potential issueFix broken MDX link for dedupe strategies
Change-[deduping strategies](api/#dedupe-strategies) +[deduping strategies](/components/contributing/api/#dedupe-strategies)to correct the anchor path.
🧰 Tools
🪛 GitHub Actions: Validate MDX Links
[error] 30-30: Broken link: /components/api/#dedupe-strategies (file not found)
🧹 Nitpick comments (7)
docs-v2/pages/projects/index.mdx (1)
69-69: Remove trailing punctuation in alt text.Alt text should be concise and typically exclude terminal punctuation. Consider changing:
to
docs-v2/pages/workflows/building-workflows/code/nodejs/ai-code-generation.mdx (1)
44-44: Hyphenate compound modifier.Per style, use “reference-specific” instead of “reference specific”:
- ...and reference specific API endpoints... + ...and reference-specific API endpoints...🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: When ‘reference-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...buting/api/#async-options-example), and reference specific API endpoints you want to use for the s...(SPECIFIC_HYPHEN)
docs-v2/pages/components/contributing/typescript.mdx (1)
91-91: Nitpick: redundant hyphen in “strictly-typed”.Consider changing “strictly-typed” to “strictly typed” for consistency with style guidelines.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~91-~91: The hyphen in strictly-typed is redundant.
Context: ...issues durin the beta: -thisis strictly-typed withinmethods,run,hooks, and e...(ADVERB_LY_HYPHEN_FIX)
docs-v2/pages/connect/components.mdx (1)
12-12: Internal link updated correctly for components reference; nitpick on comma usage.The link to
/components/contributing/is correct. Consider adding a comma for readability:
“Your end users configure the inputs, and these components produce a result that's exported as output.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...s of code. Your end users configure the inputs and these components produce a result t...(AI_HYDRA_LEO_MISSING_COMMA)
docs-v2/pages/components/contributing/index.mdx (1)
57-57: Verify 'sources' link target
The[sources](/workflows/building‑workflows/triggers/)link remains under the workflows section but appears in the “Contribution Process” context. Should this instead point to/components/contributing/quickstart/nodejs/sources/to stay within the contributing guide?docs-v2/next-sitemap.config.js (1)
1-33: Refine sitemap configuration
The basicnext-sitemapconfig is good, but consider the following optional refinements:
- Enable
autoLastmodat the top level soconfig.autoLastmodis defined.- Prefix each
locwithconfig.basePathto ensure URLs include/docs.- Optionally split large sitemaps with
sitemapSizeor addgenerateIndexSitemap.Apply this diff for clarity:
module.exports = { siteUrl: "https://pipedream.com", + autoLastmod: true, generateRobotsTxt: true, basePath: "/docs", outDir: "public", changefreq: "daily", priority: 0.7, exclude: ["/hidden/*", "/deprecated/*"], transform: async (config, path) => { const fullPath = `${config.basePath}${path}`; return { - loc: path, + loc: fullPath, changefreq: config.changefreq, priority: config.priority, lastmod: config.autoLastmod ? new Date().toISOString() : undefined, alternateRefs: config.alternateRefs ?? [], }; }, robotsTxtOptions: { policies: [{ userAgent: "*", allow: "/" }], }, };docs-v2/next.config.mjs (1)
464-503: Well-structured comprehensive redirect implementation.The added redirects form a complete set of rules to handle the documentation restructuring:
- Moving from
/integrations/to/apps/- Moving from
/workflows/contributing/components/to/components/contributing/- Moving from
/workflows/projects/to/projects/- Moving from
/workflows/workspaces/to/workspaces/All redirects are marked as permanent, which is appropriate for structural URL changes and helps preserve SEO value.
Consider adding a comment before this set of redirects to explain the purpose of this documentation restructuring for future maintainers, especially since this appears to be a significant change.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs-v2/package-lock.jsonis excluded by!**/package-lock.jsondocs-v2/yarn.lockis excluded by!**/yarn.lock,!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (65)
docs-v2/.gitignore(1 hunks)docs-v2/next-sitemap.config.js(1 hunks)docs-v2/next.config.mjs(1 hunks)docs-v2/package.json(2 hunks)docs-v2/pages/_meta.tsx(1 hunks)docs-v2/pages/account/user-settings.mdx(1 hunks)docs-v2/pages/apps/_meta.tsx(1 hunks)docs-v2/pages/apps/apps.mdx(2 hunks)docs-v2/pages/apps/connected-accounts.mdx(2 hunks)docs-v2/pages/apps/external-auth.mdx(2 hunks)docs-v2/pages/components/_meta.tsx(1 hunks)docs-v2/pages/components/contributing/actions-quickstart.mdx(7 hunks)docs-v2/pages/components/contributing/api.mdx(5 hunks)docs-v2/pages/components/contributing/guidelines.mdx(15 hunks)docs-v2/pages/components/contributing/index.mdx(2 hunks)docs-v2/pages/components/contributing/sources-quickstart.mdx(1 hunks)docs-v2/pages/components/contributing/typescript.mdx(2 hunks)docs-v2/pages/components/index.mdx(3 hunks)docs-v2/pages/connect/api.mdx(13 hunks)docs-v2/pages/connect/components.mdx(5 hunks)docs-v2/pages/connect/index.mdx(1 hunks)docs-v2/pages/connect/managed-auth/oauth-clients.mdx(2 hunks)docs-v2/pages/connect/mcp.mdx(1 hunks)docs-v2/pages/connect/workflows.mdx(2 hunks)docs-v2/pages/deprecated/migrate-from-v1/index.mdx(5 hunks)docs-v2/pages/deprecated/nodejs20-faq-2024-02/index.mdx(4 hunks)docs-v2/pages/glossary.mdx(8 hunks)docs-v2/pages/index.mdx(3 hunks)docs-v2/pages/pricing/index.mdx(1 hunks)docs-v2/pages/privacy-and-security/best-practices.mdx(1 hunks)docs-v2/pages/privacy-and-security/index.mdx(1 hunks)docs-v2/pages/projects/index.mdx(1 hunks)docs-v2/pages/projects/secrets.mdx(1 hunks)docs-v2/pages/rest-api/index.mdx(18 hunks)docs-v2/pages/troubleshooting.mdx(2 hunks)docs-v2/pages/workflows/_meta.tsx(0 hunks)docs-v2/pages/workflows/building-workflows/actions.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/index.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/ai-code-generation.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/auth.mdx(2 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/browser-automation.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/index.mdx(3 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/sharing-code.mdx(2 hunks)docs-v2/pages/workflows/building-workflows/code/python/auth.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/http.mdx(2 hunks)docs-v2/pages/workflows/building-workflows/sources.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/triggers.mdx(5 hunks)docs-v2/pages/workflows/cli/reference.mdx(5 hunks)docs-v2/pages/workflows/data-management/databases/index.mdx(1 hunks)docs-v2/pages/workflows/data-management/destinations/email.mdx(1 hunks)docs-v2/pages/workflows/data-management/destinations/emit.mdx(1 hunks)docs-v2/pages/workflows/data-management/destinations/http.mdx(1 hunks)docs-v2/pages/workflows/data-management/destinations/index.mdx(3 hunks)docs-v2/pages/workflows/data-management/destinations/s3.mdx(1 hunks)docs-v2/pages/workflows/data-management/destinations/sse.mdx(1 hunks)docs-v2/pages/workflows/environment-variables.mdx(3 hunks)docs-v2/pages/workflows/event-history.mdx(2 hunks)docs-v2/pages/workflows/git.mdx(2 hunks)docs-v2/pages/workflows/index.mdx(2 hunks)docs-v2/pages/workspaces/domain-verification.mdx(1 hunks)docs-v2/pages/workspaces/index.mdx(2 hunks)docs-v2/pages/workspaces/sso/google.mdx(1 hunks)docs-v2/pages/workspaces/sso/index.mdx(1 hunks)docs-v2/pages/workspaces/sso/okta.mdx(1 hunks)docs-v2/pages/workspaces/sso/saml.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- docs-v2/pages/workflows/_meta.tsx
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/workflows/building-workflows/code/nodejs/ai-code-generation.mdx
[uncategorized] ~44-~44: When ‘reference-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...buting/api/#async-options-example), and reference specific API endpoints you want to use for the s...
(SPECIFIC_HYPHEN)
docs-v2/pages/account/user-settings.mdx
[style] ~53-~53: Consider a shorter alternative to avoid wordiness.
Context: ...s/#requiring-two-factor-authentication) in order to log in to Pipedream. If you are a memb...
(IN_ORDER_TO_PREMIUM)
docs-v2/pages/connect/components.mdx
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...s of code. Your end users configure the inputs and these components produce a result t...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~457-~457: Consider replacing this phrase with the adverb “differently” to avoid wordiness.
Context: ...-props), and they need to be configured in a different way. Props that are dynamic will have a `re...
(IN_A_X_MANNER)
docs-v2/pages/components/contributing/typescript.mdx
[uncategorized] ~91-~91: The hyphen in strictly-typed is redundant.
Context: ...issues durin the beta: - this is strictly-typed within methods, run, hooks, and e...
(ADVERB_LY_HYPHEN_FIX)
docs-v2/pages/workflows/building-workflows/code/nodejs/index.mdx
[style] ~180-~180: Try using a synonym here to strengthen your writing.
Context: ... have access to the $ variable, which gives you access to methods like $.respond, `$....
(GIVE_PROVIDE)
docs-v2/pages/workflows/cli/reference.mdx
[misspelling] ~305-~305: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ce If you're working with resources in an workspace, you'll need ...
(EN_A_VS_AN)
docs-v2/pages/components/contributing/guidelines.mdx
[uncategorized] ~341-~341: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e). If a prop definition does not exist and you are adding an app-specific prop tha...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~343-~343: Possible missing preposition found.
Context: ...initions will also be surfaced for apps the Pipedream marketplace. ##### Methods ...
(AI_HYDRA_LEO_MISSING_IN)
[uncategorized] ~499-~499: The noun “dropdown” is spelled as one word.
Context: ...ns) so users can make selections from a drop down menu. For example, Todoist identifies p...
(LOCKDOWN)
docs-v2/pages/index.mdx
[grammar] ~57-~57: Is there a word missing between these two verbs?
Context: ...ocess) via GitHub. ## Contributing We hope is that by providing a generous free tier,...
(PRP_VB_BE)
docs-v2/pages/workflows/building-workflows/code/nodejs/sharing-code.mdx
[style] ~148-~148: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...egistry](/components/contributing/). 3. Node.js code step actions have a slightly di...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 GitHub Actions: Validate MDX Links
docs-v2/pages/components/index.mdx
[error] 8-8: Broken link: /components/api/#component-structure (file not found)
[error] 8-8: Broken link: /components/api/#using-npm-packages (file not found)
[error] 27-27: Broken link: /components/api/#interface-props (file not found)
[error] 29-29: Broken link: /components/api/#db (file not found)
[error] 30-30: Broken link: /components/api/#dedupe-strategies (file not found)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: pnpm publish
🔇 Additional comments (131)
docs-v2/.gitignore (1)
36-38: Ignore generated sitemap and robots files
These rules correctly prevent committing autogenerated sitemap XML files androbots.txtunderpublic/.docs-v2/pages/workspaces/sso/google.mdx (1)
9-9: Update workspace link path
The link to workspaces now correctly points to/workspaces/, aligning with the new docs structure.docs-v2/pages/workspaces/sso/okta.mdx (1)
10-10: Correct workspace URL
The SSO requirements link now uses/workspaces/, matching the standardized path.docs-v2/pages/workspaces/domain-verification.mdx (1)
5-5: Standardize SSO configuration link
The link now correctly targets/workspaces/sso/, reflecting the updated docs hierarchy.docs-v2/pages/components/contributing/sources-quickstart.mdx (1)
682-682: Fix detailed component reference URL
The link now points to/components/contributing/api/, consistent with the revised documentation paths.docs-v2/pages/workspaces/sso/saml.mdx (1)
9-9: Updated internal link for workspace SSO requirement
The link has been corrected to remove the/workflows/prefix, now pointing to/workspaces/. This aligns with the new URL structure and ensures users navigate to the correct workspace page.docs-v2/pages/workspaces/sso/index.mdx (1)
24-24: Corrected domain verification link
The hyperlink now references/workspaces/domain-verification/, consistent with the reorganized workspace documentation. This update maintains internal link consistency across the docs.docs-v2/pages/connect/index.mdx (1)
67-67: Updated "Connected Account" glossary link
Changed the path from/integrations/connected-accountsto/apps/connected-accounts, matching the overall migration from “integrations” to “apps.” This ensures the glossary term directs users to the new apps documentation.docs-v2/pages/workflows/data-management/destinations/s3.mdx (1)
25-25: Link to component action authoring guide updated
The link now correctly points to/components/contributing/#actionsinstead of the old/workflows/contributing/components/#actions. This aligns with the new documentation structure for component contribution guidelines.docs-v2/pages/workflows/data-management/destinations/emit.mdx (1)
50-50: Updated component action reference in emit docs
The URL has been updated to/components/contributing/#actions, reflecting the consolidated path for component contribution documentation. This change ensures consistency with other component docs.docs-v2/pages/workflows/building-workflows/code/index.mdx (1)
9-9: Updated "actions" link correctly aligned
The hyperlink now points to/components/contributing/#actions, matching the new documentation structure across the site.docs-v2/pages/workflows/data-management/destinations/sse.mdx (1)
64-64: Consistent component action link path
The URL for authoring component actions has been updated to/components/contributing/#actions, aligning with the global restructure of component contribution guides.docs-v2/pages/privacy-and-security/best-practices.mdx (1)
9-9: Corrected connected accounts link path
The internal link now references/apps/connected-accounts/, reflecting the new destination for managing connected accounts in Pipedream.docs-v2/pages/connect/mcp.mdx (1)
86-86: Simplified Pipedream project link
The link to project creation is now/projects/#creating-projects, consistent with the updated URL scheme for projects.docs-v2/pages/workflows/data-management/databases/index.mdx (1)
18-18: Updated connected account link to new apps path
The documentation now points to/apps/connected-accountsfor configuring shared static IP routing, matching the unified docs layout.docs-v2/pages/account/user-settings.mdx (1)
53-53: Update 2FA requirement link to new path
The internal link has been correctly updated from/workflows/workspaces/#requiring-two-factor-authenticationto/workspaces/#requiring-two-factor-authentication, aligning with the new workspace documentation structure.🧰 Tools
🪛 LanguageTool
[style] ~53-~53: Consider a shorter alternative to avoid wordiness.
Context: ...s/#requiring-two-factor-authentication) in order to log in to Pipedream. If you are a memb...(IN_ORDER_TO_PREMIUM)
docs-v2/pages/workflows/data-management/destinations/email.mdx (1)
40-40: Correct component action link path
The link for component action contribution has been properly updated from/workflows/contributing/components/#actionsto/components/contributing/#actions, ensuring consistency with the new docs structure.docs-v2/pages/apps/external-auth.mdx (2)
22-22: Fix image asset path for external auth selector
The screenshot path was updated from/images/integrations/select-external-auth.pngto/images/apps/select-external-auth.png, matching the new directory layout.
45-45: Ensure consistency of repeated image path update
The second instance of the "Select External Auth" image has been correctly updated to/images/apps/select-external-auth.png.docs-v2/pages/privacy-and-security/index.mdx (1)
67-67: Standardize SSO documentation link
The single-sign-on link was updated from/workflows/workspaces/#configuring-single-sign-on-ssoto/workspaces/#configuring-single-sign-on-sso, aligning with other workspace-related doc updates.docs-v2/pages/workflows/data-management/destinations/http.mdx (1)
70-70: Update component action reference for HTTP destination
The link for component actions was correctly changed from/workflows/contributing/components/#actionsto/components/contributing/#actions, keeping the documentation consistent.docs-v2/pages/projects/index.mdx (1)
69-69: Verify the updated Cloudinary image path.The new URL contains
docs/docs/projects—ensure this reflects the correct Cloudinary directory structure (i.e., thatdocs/docs/projects/...is the intended path after removing/workflows/projects/).docs-v2/pages/workflows/building-workflows/code/nodejs/ai-code-generation.mdx (1)
44-44: Confirm updated API link paths.You’ve updated links from
/workflows/contributing/components/api/to/components/contributing/api/(and its anchors). Please verify that all three new paths (/components/contributing/api/,/#props,/#async-options-example) resolve correctly in the docs site.🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: When ‘reference-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...buting/api/#async-options-example), and reference specific API endpoints you want to use for the s...(SPECIFIC_HYPHEN)
docs-v2/pages/workflows/building-workflows/sources.mdx (1)
146-146: Confirm updated component links.You updated the quickstart link and API docs link from
/workflows/contributing/components/...to/components/contributing/.... Please verify that:
/components/contributing/sources-quickstart//components/contributing/api/
both resolve correctly and match the intended location.docs-v2/pages/projects/secrets.mdx (1)
5-5: Verify the updated access-controls path.The link was changed from
/workflows/projects/access-controls#managing-accessto/projects/access-controls#managing-access. Please confirm this new route is valid and points to the correct section in the docs.docs-v2/pages/workflows/index.mdx (2)
18-18: Verify updated "pre-built actions" link.The link now points to
/components/contributing/#actionsinstead of/workflows/contributing/components/#actions. Please ensure this anchor exists and works as intended.
31-31: Verify updated "Actions" link.Similarly, confirm that
[Actions](/components/contributing/#actions)resolves correctly and that the anchor#actionsis present on the target page.docs-v2/pages/connect/workflows.mdx (2)
115-115: Update Project ID link path
The link to the Project ID page has been corrected to/projects/#finding-your-projects-id, aligning with the new docs structure.
271-271: Update Project ID link path
Consistent with the other update, this link now points to/projects/#finding-your-projects-idinstead of the old/workflows/projects/path.docs-v2/pages/workflows/building-workflows/actions.mdx (2)
33-33: Update action contribution quickstart link
The path for the action development quickstart has been updated from/workflows/contributing/components/to/components/contributing/, matching the reorganized docs.
35-35: Update Pipedream registry link
The registry link now correctly uses/components/contributing/as its base, consistent with the new URL structure.docs-v2/pages/workflows/building-workflows/code/nodejs/browser-automation.mdx (1)
518-518: Correct contribution quickstart paths
The links to both the actions and sources quickstarts have been updated to/components/contributing/..., reflecting the consolidated component-contributing directory.docs-v2/pages/workflows/building-workflows/code/python/auth.mdx (1)
3-3: Update prebuilt actions and connected accounts links
The links now point to/components/contributing/#actionsfor prebuilt actions and/apps/connected-accounts/#connecting-accountsfor account setup, in line with the new structure.docs-v2/pages/apps/connected-accounts.mdx (2)
15-15: Update external-auth link path
The guide link has been updated to/apps/connected-accounts/external-auth/, replacing the old/integrations/...path with the new apps-based URL.
239-239: Update external-auth guide link
Consistently updated the second occurrence of the external-auth path to the new/apps/connected-accounts/external-auth/.docs-v2/pages/components/contributing/api.mdx (5)
6-6: URL path updated for TypeScript docs link.The link has been updated from
/workflows/contributing/components/typescript/to/components/contributing/typescript/as part of the documentation restructuring effort.
9-9: Multiple documentation paths updated in main description.All documentation links have been updated from the
/workflows/contributing/pattern to/components/contributing/, maintaining consistency with the new documentation structure.
30-30: Updated quickstart guide URLs.Links to source and action quickstart guides now follow the
/components/contributing/pattern instead of/workflows/contributing/.
92-92: Updated link to Pipedream registry guidelines.The link to component versioning documentation now uses the new path structure.
627-627: Updated app files documentation link.Reference to app files documentation now follows the new URL pattern.
docs-v2/pages/connect/managed-auth/oauth-clients.mdx (2)
6-6: Updated OAuth clients documentation link.The link has been updated from
/integrations/connected-accounts/oauth-clientsto/apps/connected-accounts/oauth-clientsas part of the documentation restructuring where "integrations" have been renamed to "apps".
32-32: Updated link to OAuth client configuration.The link to OAuth client configuration documentation now uses the
/apps/path prefix instead of/integrations/.docs-v2/pages/pricing/index.mdx (1)
5-5: Updated links to component documentation in pricing intro.References to sources and actions documentation now use the new
/components/contributing/path structure instead of/workflows/contributing/components/, while keeping the same anchors.docs-v2/pages/components/contributing/actions-quickstart.mdx (3)
9-9: Updated link to actions documentation.The URL now uses the newer path structure
/components/contributing/#actionsinstead of/workflows/contributing/#actions.
19-19: Updated migration guide link.Reference to the migration guide now follows the new path structure.
60-60: Updated multiple references to component API documentation.All links to the component API, including sections for props, app props, and actions, now follow the new path structure
/components/contributing/api/instead of/workflows/contributing/api/.Also applies to: 112-112, 343-343, 400-400, 489-489
docs-v2/pages/apps/_meta.tsx (1)
5-7: External Auth section now hidden from navigation.Changed from
"external-auth": "External Auth"to"external-auth": { display: "hidden" }, which will hide this section from the navigation menu while maintaining the underlying content.This change is part of the documentation restructuring effort, and likely indicates that this content is being moved or reorganized. Make sure users can still access this information through other navigation paths if needed.
docs-v2/pages/workflows/event-history.mdx (2)
12-12: Internal link updated correctly for project access controls.The URL now points to
/projects/access-controls/#permissions, matching the new docs structure.
22-22: Internal link updated correctly for workspace switching.The link now uses
/workspaces/#switching-between-workspaces, consistent with the renamed section.docs-v2/pages/workspaces/index.mdx (2)
17-17: Internal link updated correctly for renaming a workspace.The anchor
/workspaces/#renaming-a-workspacealigns with the new URL hierarchy.
60-60: Internal link updated correctly for switching workspaces.The link to
/workspaces/#switching-between-workspacesnow matches the relocated content.docs-v2/pages/components/contributing/typescript.mdx (1)
24-24: Internal link updated correctly for TypeScript component quickstart.The path
/components/contributing/replaces the old/workflows/contributing/components/prefix.docs-v2/pages/connect/components.mdx (3)
6-6: Internal link updated correctly for triggers and actions.The link now points to
/components/contributing/, reflecting the new base path.
224-224: Internal link updated correctly for component structure.Redirecting to
/components/contributing/api/#component-structurealigns with the new API docs.
252-252: Internal link updated correctly for props.Updating to
/components/contributing/api/#propscorrectly maps to the relocated props section.docs-v2/pages/workflows/building-workflows/http.mdx (2)
26-26: Internal link updated correctly for the Pipedream Component Registry.The path
/components/contributing/is now used instead of the legacy workflows prefix.
217-217: Internal link updated correctly for actions API reference.Linking to
/components/contributing/api/#actionsreflects the new location of the API docs.docs-v2/pages/components/contributing/index.mdx (3)
6-6: Internal link updated correctly
The anchor for[components](/components/contributing/)now points to the new top‑level contributing page as intended.
14-15: Quickstart links updated
The quickstart guides for sources and actions now point to/components/contributing/quickstart/...and/components/contributing/actions‑quickstart/. This aligns with the new docs structure.
64-64: Component guidelines link
The link to[Component Guidelines & Patterns](/components/contributing/guidelines/)correctly reflects the new contributing path.docs-v2/pages/_meta.tsx (1)
4-9: Navigation metadata updated
The new keys (workspaces,projects,workflows,apps,components) are correctly inserted in the intended order to reflect the reorg.docs-v2/pages/troubleshooting.mdx (2)
252-252: Downgrade workflow link updated
The legacy contribution‑process anchor now points to/components/contributing/#contribution-process, matching the new contributing guide.
301-301: Component API link updated
The[Component API](/components/contributing/api/)link now directs to the correct API reference under the contributing section.docs-v2/pages/deprecated/migrate-from-v1/index.mdx (4)
23-23: Migration guide link updated
The “contribute your own components” link correctly points to the new contributing landing page.
105-105: Component API reference link
The link to[Component API](/components/contributing/api/)is correctly updated to the API endpoint.🧰 Tools
🪛 LanguageTool
[grammar] ~105-~105: A hyphen is missing in the adjective “built-in”.
Context: ... think of the$as the entry point to built in Pipedream functions. In v1, this specia...(BUILT_IN_HYPHEN)
186-186: Props anchor link
The[props](/components/contributing/api/#component-api)anchor now correctly refers to the API’s “component-api” section.
218-218: Props anchor link
The[props](/components/contributing/api/#props)link correctly jumps to the props section of the API docs.docs-v2/pages/components/_meta.tsx (1)
3-4: Section metadata revised
The"components"key was replaced by"contributing"to reflect the new section structure under/components.docs-v2/package.json (2)
9-9: Add postbuild script for sitemap generation
The newpostbuildscript runsnext-sitemapautomatically after building the site, ensuring sitemaps stay up-to-date. Make sure the correspondingnext-sitemap.config.jsfile exists and is correctly referenced in the repo.
37-37: Includenext-sitemapin devDependencies
Addingnext-sitemap@^4.2.3todevDependenciesaligns with the new sitemap generation step. Ensure there are no version conflicts with the rest of your toolchain.docs-v2/pages/components/index.mdx (3)
13-13: Update TypeScript docs link
The callout now correctly points to/components/contributing/typescript/, aligning with the new documentation structure.
97-98: Quickstart Guides paths updated
Links to/components/contributing/sources-quickstart/and/components/contributing/actions-quickstart/reflect the new structure and look correct.
102-102: Component API Reference link updated
The link to/components/contributing/api/is valid and aligns with the updated URL scheme.docs-v2/pages/apps/apps.mdx (2)
9-10: Internal link updates for Apps integration
The links to/apps/connected-accounts/and/components/contributing/#actionshave been updated to reflect the new structure. Ensure the#connecting-accountsand#actionsanchors exist on their target pages.
76-76: Update contribution link for missing integrations
The link now points to/components/contributing/, directing users to the component contribution guide. Verify that this path leads users to the intended "contribution process" section.docs-v2/pages/workflows/data-management/destinations/index.mdx (3)
3-3: Components link updated in Destinations overview
The reference to/components/contributing/#actionsreplaces the legacy workflows path, aligning with the new docs hierarchy.
73-73: Authoring component actions link updated
The component action link now correctly points to/components/contributing/#actions.
93-93: API docs link updated for actions
The link to/components/contributing/api/#actionsis valid for the component action API section.docs-v2/pages/workflows/building-workflows/code/nodejs/index.mdx (5)
153-153: Update props reference link
The link now points to the consolidated props API at/components/contributing/api/#props. Ensure that the#propsanchor is present on that page.
169-169: Link to Node.js component API index updated
The link to/components/contributing/api/replaces the legacy API path. Confirm that this page serves as the API overview entrypoint.
172-172: Connect account link updated for code steps
The path/apps/connected-accounts/#from-a-code-stepreflects the new connected accounts docs. Verify that the#from-a-code-stepanchor exists.
180-180: Update link for additional API methods
The "and more" link now correctly refers to/components/contributing/api/#actions. Ensure the anchor is accurate.🧰 Tools
🪛 LanguageTool
[style] ~180-~180: Try using a synonym here to strengthen your writing.
Context: ... have access to the$variable, which gives you access to methods like$.respond, `$....(GIVE_PROVIDE)
182-182: Reinforce connected accounts usage in component context
The repeated link clarifies where to configure auth in components. This duplication is intentional for emphasis.docs-v2/pages/deprecated/nodejs20-faq-2024-02/index.mdx (1)
56-56: Verify updated "Connect" link target
The link was changed from/integrations/connected-accounts/#...to/apps/connected-accounts/#connecting-accounts. Please confirm that the#connecting-accountsanchor exists on the/apps/connected-accountspage and resolves correctly.docs-v2/pages/workflows/building-workflows/code/nodejs/auth.mdx (2)
7-7: Validate "prebuilt actions" link update
The URL was updated to/components/contributing/#actions. Ensure that the#actionsanchor is defined on thecomponents/contributingpage so this link navigates to the intended section.
118-118: Confirm "connecting an account to a code step" link
The path now points to/apps/connected-accounts/#from-a-code-step. Please verify that the#from-a-code-stepanchor is present on theapps/connected-accountspage and directs users to the correct instructions.docs-v2/pages/components/contributing/guidelines.mdx (5)
116-116: Approve updated component-structure link
The registry components link was updated to/components/contributing/api/#component-structure. This aligns with the new URL structure.
196-198: Approve Node.js client library link
Updated link to/components/contributing/api/#using-npm-packagescorrectly reflects the client‑library section in the API docs.
324-324: Approve secret prop link
The link to/components/contributing/api/#generalnow points to the general props section. Looks correct.
338-338: Approve prop-definitions example link
The anchor/components/contributing/api/#prop-definitions-examplematches the example section in the API docs.
346-346: Approve methods link update
Linking to/components/contributing/api/#methodscorrectly references the methods section in the API specification.docs-v2/pages/glossary.mdx (8)
79-79: Approve component definition link
The reference to/components/contributing/api/correctly points to the Component API documentation.
99-99: Approve integration anchor link
The internal anchor#integrationsis consistent with the Glossary entry for "Integrations".
103-103: Approve connected-accounts access-control link
The link to/apps/connected-accounts#access-controlmatches the access control section for connected accounts.
229-229: Approve external-credentials link
Linking to#connected-accountcorrectly points back to the Connected Account definition.
235-235: Approve file-stores link
The new/projects/file-storespath correctly references File Store docs.
335-335: Approve premium-apps anchor
The#integrationsanchor under "Premium apps" aligns with the Glossary term.
338-338: Approve projects overview link
The/projects/path correctly directs users to Project documentation.
343-343: Approve project-access-controls link
The link to/projects/access-controlscorrectly covers project-based access control docs.docs-v2/pages/workflows/cli/reference.mdx (6)
62-62: Verify CLI quickstart sources link
The URL/components/contributing/quickstart/nodejs/sources/was introduced. Please confirm that this directory exists and contains the intended quickstart content.
124-124: Approve init-app link
Linking to/components/contributing/guidelines/#app-filescorrectly points to the app‑files section in the guidelines.
133-133: Approve init-action link
The anchor/components/contributing/#actionsaligns with the Actions section of the component contribution guide.
149-149: Approve init-source props links
Paths/components/contributing/api/#db,#/http, and#/timercorrectly map to the respective prop API sections.
305-305: Approve workspace profile setup link
The/workspaces/path is correct for workspace-level documentation.🧰 Tools
🪛 LanguageTool
[misspelling] ~305-~305: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ce If you're working with resources in an workspace, you'll need ...(EN_A_VS_AN)
307-307: Approve workspace ID retrieval link
Link to/workspaces/#finding-your-workspaces-idcorrectly points to the section for locating a workspace's ID.docs-v2/pages/connect/api.mdx (2)
10-10: Approve updated project base path link
The link to the projects overview has been updated to/projects/, which aligns with the new documentation structure.
253-253:✅ Verification successful
Verify anchor existence for project ID section
Please confirm that the anchor#finding-your-projects-idexists in the/projects/page; otherwise this link will 404.Run this script from the repo root to validate the heading ID in the target file:
🏁 Script executed:
#!/bin/bash # Search for the markdown heading whose slug becomes "finding-your-projects-id" rg -n '##+\s.*Finding Your Projects? ID' docs-v2/pages/projects/Length of output: 66
🏁 Script executed:
#!/bin/bash # List all markdown headings in the projects docs directory rg -n '^#{2,6}\s' docs-v2/pages/projects/ # Specifically search for any heading containing "Finding Your Project" and "ID" rg -n '^#{2,6}\s.*Finding Your Project.*ID' docs-v2/pages/projects/Length of output: 732
Anchor exists for Finding your project’s ID
The heading
• docs-v2/pages/projects/index.mdx:78
“## Finding your project’s ID”
generates the slug#finding-your-projects-id, so the link indocs-v2/pages/connect/api.mdxis valid. No changes needed.docs-v2/pages/workflows/git.mdx (3)
198-199: Approve private component link update
The link for private component usage has been updated to/components/contributing/#using-private-actions, matching the new path.
200-201: Approve registry action link update
The registry action example now correctly points to/components/contributing/.
222-223: Approve connected-accounts access control link
The link to workspace-level access control is now/apps/connected-accounts/#access-control, which aligns with the new “apps” section.docs-v2/pages/workflows/building-workflows/triggers.mdx (4)
90-91: Approve updated “action” link in HTTP docs
The HTTP trigger section now references the[action](/components/contributing/#actions)path correctly.
595-596: Approve action vs. destination link in notifications
The “Trigger a notification…” section correctly uses/components/contributing/#actionsand the existing destinations path.
609-610: Approve actions & destinations link
The combined reference to[Actions](/components/contributing/#actions)and[Destinations](/workflows/data-management/destinations/)is now consistent with the new docs layout.
775-776: Approve event data reference link
The wrap-up line correctly uses/components/contributing/#actionsalongside the code step link.docs-v2/pages/workflows/environment-variables.mdx (3)
14-14: Approve project access-control link
The Project-scoped variables section now points to/projects/access-controls, matching the new path.
107-107: Approve “Actions” component link
The introduction to Actions correctly links to/components/contributing/#actions.
118-118: Approve private components reference
The guidance on private components now points to/components/contributing/#using-components.docs-v2/pages/workflows/building-workflows/code/nodejs/sharing-code.mdx (3)
6-6: Link path updated to match new documentation structure.The link to the Actions documentation has been updated from
/workflows/contributing/components/#actionsto/components/contributing/#actionsas part of the broader documentation restructuring.
12-12: Link path updated to match new documentation structure.The link to the actions quickstart guide has been updated from
/workflows/contributing/components/actions-quickstart/to/components/contributing/actions-quickstart/. This change is consistent with the reorganization of documentation paths.
146-148: Multiple links updated to match new documentation structure.All three links for component guidelines, Pipedream Component Registry, and component API have been updated to use the new
/components/contributing/path structure instead of the previous/workflows/contributing/components/or/workflows/contributing/paths.Note: The static analysis raised a style issue about three consecutive sentences beginning with "Node.js" - consider varying sentence structure in future edits for improved readability.
🧰 Tools
🪛 LanguageTool
[style] ~148-~148: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...egistry](/components/contributing/). 3. Node.js code step actions have a slightly di...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs-v2/pages/index.mdx (3)
12-12: Link path updated to match new documentation structure.The link for "OAuth and key-based authentication" has been updated from
/integrations/connected-accounts/to/apps/connected-accounts/as part of the site-wide documentation restructuring.
28-29: Component development links updated to the new path structure.Both custom actions and custom triggers links have been updated from
/workflows/contributing/components/paths to the new/components/contributing/structure, maintaining consistency with the documentation restructuring.
53-53: Link to contribution process updated to new path structure.The link to the contribution process has been updated from
/workflows/contributing/#contribution-processto/components/contributing/#contribution-process.docs-v2/pages/rest-api/index.mdx (4)
78-78: Workspace-related links updated to new path structure.The links for finding workspace IDs have been updated from
/workflows/workspaces/#finding-your-workspaces-idto/workspaces/#finding-your-workspaces-id, aligning with the new documentation organization.Also applies to: 83-83
170-170: Connected accounts link updated to new path structure.The link to connected accounts documentation has been updated from
/integrations/connected-accounts/to/apps/connected-accounts/.
244-245: Multiple component-related API links updated throughout the file.All references to component API documentation have been updated from
/workflows/contributing/components/api/to/components/contributing/api/. This ensures consistency with the broader documentation restructuring.Also applies to: 486-487, 965-966, 990-990, 1047-1047, 1070-1070, 1137-1137
1531-1531: Workspace-related API links and examples updated.All API endpoint paths and documentation links related to workspaces have been updated from
/workflows/workspaces/paths to/workspaces/. This includes both the documentation links and the actual API endpoint paths in examples.Also applies to: 1541-1542, 2083-2083, 2094-2095, 2136-2137, 2175-2175
docs-v2/next.config.mjs (4)
464-468: Added redirect rule for integrations paths.This new redirect rule ensures that all paths previously under
/integrations/are now redirected to/apps/, which aligns with the documentation updates seen in other files. The permanent flag ensures proper SEO handling.
469-483: Added redirect rules for component-related paths.These redirects ensure that all paths previously under:
/workflows/contributing/components//workflows/contributing/components/:path*//workflows/contributing/are now redirected to
/components/contributing/and its subpaths. This is consistent with the link updates observed in the documentation files.
484-493: Added redirect rules for project-related paths.These redirects map project-related paths from
/workflows/projects/to/projects/, simplifying the URL structure while maintaining backward compatibility through permanent redirects.
494-503: Added redirect rules for workspace-related paths.These redirects ensure that all paths previously under
/workflows/workspaces/are now redirected to/workspaces/, consistent with the API documentation updates seen in the REST API file.
WHY
Summary by CodeRabbit
New Features
Bug Fixes
Chores