Docs updates for Connect #17148
Docs updates for Connect #17148
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
WalkthroughThe documentation and configuration were updated to clarify pricing, credit usage, and plan terminology. Navigation metadata was restructured with new separators and section titles. Multiple links were updated for consistency. Example code and descriptions were corrected for accuracy, and a template for a dismissible banner was added as a comment in the theme configuration. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs Site
participant ThemeConfig
User->>Docs Site: Navigates documentation
Docs Site->>Docs Site: Displays updated navigation with separators
User->>Docs Site: Reads pricing, billing, or usage docs
Docs Site->>Docs Site: Shows clarified terminology and updated links
User->>Docs Site: Views code examples
Docs Site->>Docs Site: Presents corrected code and explanations
ThemeConfig-->>Docs Site: (Commented) Banner template available for future use
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 1
🧹 Nitpick comments (3)
docs-v2/pages/workflows/building-workflows/sharing.mdx (1)
134-134: Use consistent terminology in link text.The link text still reads “Free tier” while the rest of the docs use “Free plan.” Please update the link text to
[Free plan](/pricing/#free-plan)for consistency.docs-v2/pages/pricing/index.mdx (2)
11-26: Consistent renaming to "Free plan" and clear limitations.
The free plan section uses the new terminology uniformly, and the bullet-point layout is organized. Consider adding a comma after "features" on line 13 for improved readability:- Workspaces on the Free plan have access to many of the Pipedream features including [Workflows](/workflows) and [Connect](/connect). + Workspaces on the Free plan have access to many of the Pipedream features, including [Workflows](/workflows) and [Connect](/connect).
174-180: Upgrade/Downgrade explanations look good.
Suggest removing the redundant “of” on line 180:- ...features outside of the new billing plan... + ...features outside the new billing plan...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (15)
docs-v2/pages/_meta.tsx(1 hunks)docs-v2/pages/account/billing-settings.mdx(1 hunks)docs-v2/pages/connect/_meta.tsx(1 hunks)docs-v2/pages/connect/api-proxy.mdx(1 hunks)docs-v2/pages/connect/api.mdx(1 hunks)docs-v2/pages/connect/mcp/openai.mdx(1 hunks)docs-v2/pages/glossary.mdx(1 hunks)docs-v2/pages/index.mdx(2 hunks)docs-v2/pages/pricing/index.mdx(5 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/python/delay.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx(1 hunks)docs-v2/pages/workflows/building-workflows/sharing.mdx(1 hunks)docs-v2/theme.config.tsx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/account/billing-settings.mdx
[grammar] ~19-~19: Make sure the noun ‘number’ is in agreement with the verb ‘run’. Beware that some collective nouns (like ‘police’ or ‘team’) can be treated as both singular and plural.
Context: ... the chart to see the number of credits run for that specific day: ![Daily credits...
(DT_NN_OF_NNS_VB)
[style] ~40-~40: For conciseness, try rephrasing this sentence.
Context: ... workflow that uses 10 credits per run, it's possible that two concurrent events trigger the workflow, and the cap won't apply u...
(MAY_MIGHT_BE)
docs-v2/pages/index.mdx
[style] ~32-~32: ‘in excess of’ might be wordy. Consider a shorter alternative.
Context: ...applications and managed data pipelines in excess of 10 million events per second (EPS) at s...
(EN_WORDINESS_PREMIUM_IN_EXCESS_OF)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ses Pipedream for a wide variety of use cases including: - AI agents and chatbots - ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs-v2/pages/pricing/index.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...an have access to many of the Pipedream features including Workflows and [...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~168-~168: Did you mean “you're” (short for ‘you are’)?
Context: ...users are tied to a billing period. Your billing period starts when you sign up ...
(YOUR)
[style] ~180-~180: This phrase is redundant. Consider using “outside”.
Context: ...flows or integrations that use features outside of the new billing plan will be automatica...
(OUTSIDE_OF)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: pnpm publish
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (35)
docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx (1)
173-173: Anchor link updated correctly.The credit usage link now points to
/pricing/#credits-and-billing, matching the revised billing documentation anchor.docs-v2/pages/connect/_meta.tsx (1)
2-2: Updated section label for consistency.Changing
"index"from “Overview” to “Pipedream Connect” aligns with the new navigation structure in_meta.tsx.docs-v2/pages/workflows/building-workflows/code/python/delay.mdx (1)
54-54: Credit usage link updated correctly.The callout link now points to
/pricing/#credits-and-billing, consistent with other credit-related documentation updates.docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx (1)
259-259: Credit usage link updated correctly.The documentation now references
/pricing/#credits-and-billingfor credit usage, matching the standardized anchor across docs.docs-v2/pages/glossary.mdx (1)
107-107: Update hyperlink to correct pricing anchor
Link updated to/pricing/#credits-and-billingto maintain consistency with billing documentation.docs-v2/pages/connect/api-proxy.mdx (1)
82-82: Correct placeholder property name for project ID
Changed placeholder toprojectIdmatching SDK expectations and documentation standards.docs-v2/pages/connect/mcp/openai.mdx (1)
120-120: UseappSlugforserver_labelto align with identifier convention
Replaced unusedappLabelwithappSlugto match the slug identifier expected by MCP tool configuration.docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx (1)
56-56: Update credit usage link to new billing anchor
Revised link to/pricing/#credits-and-billingto reflect updated pricing and billing URL anchors.docs-v2/pages/connect/api.mdx (1)
3726-3730: Relocate "Invoke workflows" under new "Workflows" headingRepositions the section correctly without content changes to reflect the new navigation structure.
docs-v2/theme.config.tsx (1)
64-73: Add commented placeholder for dismissible bannersIncludes a ready-to-use example for future product announcements without active functionality.
docs-v2/pages/account/billing-settings.mdx (5)
13-14: Update terminology and links for credit usageSwitches "[Credits]" link to
/pricing/#credits-and-billingand standardizes "free plan" terminology for consistency.
15-18: Add warning callout for Connect credit visibilityInforms users that Connect credit usage isn't yet reflected in the Usage section.
23-26: Clarify chart interactionsAdds instructions for clicking a column to see credits broken out by workflow/source.
31-36: Clarify compute budget scope and setupDetails that compute budgets apply workspace-wide, exclude dedicated workers and Connect, and explains toggling the feature.
45-45: Standardize plan terminology in Limits sectionUpdates "[Free tier]" link to
/pricing/#free-planto match updated naming conventions.docs-v2/pages/_meta.tsx (6)
2-2: Rename index label to "Introduction"Updates the navigation entry for better clarity on the landing page.
5-8: Insert separator for "Connect" sectionAdds a distinct separator entry to group Connect-related docs.
9-12: Convert "connect" entry to object with titleEnables further customization (e.g., child pages) under the Connect section.
13-16: Insert separator for "Workflows" sectionIntroduces a clear break before workflow docs in the navigation.
17-20: Convert "workflows" entry to object with titlePreps the Workflows nav entry for potential child pages.
21-24: Introduce new "Platform" separatorGroups platform-wide docs under a dedicated section.
docs-v2/pages/index.mdx (8)
5-5: Refine homepage taglineChanges "fastest" to "easiest" to better position Pipedream's value proposition.
13-13: Clarify SDKs for user authenticationSpecifies that SDKs handle user authentication for APIs, improving feature clarity.
14-14: Simplify triggers and actions descriptionRemoves redundant phrasing for source-available triggers and actions.
24-24: Condense Getting Started instructionsCombines signup and quickstart steps into a single actionable sentence.
28-28: Update developer milestone numberReflects user growth by increasing count to "more than 1 million" developers.
32-32: Highlight platform scale and pricingEmphasizes event throughput and pricing readiness for scale.
34-34: Update community link destinationRedirects community reference from
/communityto/support.
36-37: Expand use cases with AI and SaaS automationAdds "AI agents and chatbots" and "Workflow builders and SaaS automation" to use case list.
docs-v2/pages/pricing/index.mdx (6)
5-7: Great introduction update.
The expanded intro clearly emphasizes free prototyping, Connect access, and trial options, aligning with the PR’s goals.
111-113: Source credit usage section is clear.
The new "Source credit usage" heading and description accurately explain free vs. billable sources.
144-148: Included and additional credits headings updated correctly.
These sections now appear under billing with appropriate anchors and clear definitions.
160-172: Managing your plan and billing period restructured well.
The "Managing your plan" section, including billing period details, is clear and uses consistent anchor links.
186-191: Cancellation instructions are precise.
The steps and timing for cancelling are clear and actionable.
193-193: Detailed pricing info link added.
The new section directs readers to the external pricing page appropriately.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs-v2/pages/pricing/index.mdx (2)
79-79: Convert “Scenarios” label to a heading
Replace the bold**Scenarios**label with an appropriate Markdown heading (e.g.,### Scenarios) to maintain consistency with other sections.
89-89: Convert workflow memory labels to headings
Change the bold labels for memory configurations into Markdown headings (e.g.,#### Workflow segments configured to use 256MB memory (default)and similarly for 1 GB) for clearer section delineation.Also applies to: 100-100
🧹 Nitpick comments (2)
docs-v2/pages/pricing/index.mdx (2)
15-24: Convert sub-section labels to Markdown headings
For better structural consistency and accessibility, replace the bold labels (**General:**, Connect, Workflows) with proper subheadings (e.g.,### General,### Connect,### Workflows) under the Free plan section.
32-38: Verify environment variable interpolation
Ensure that{process.env.PUBLIC_APPS}is correctly resolved in your MDX build. If it doesn’t render at runtime, consider importing the value via frontmatter or a config file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs-v2/pages/pricing/index.mdx(5 hunks)docs-v2/pages/workflows/building-workflows/sharing.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs-v2/pages/workflows/building-workflows/sharing.mdx
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/pricing/index.mdx
[misspelling] ~168-~168: Did you mean “you're” (short for ‘you are’)?
Context: ...users are tied to a billing period. Your billing period starts when you sign up ...
(YOUR)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: pnpm publish
- GitHub Check: validate-links
- GitHub Check: Lint Code Base
🔇 Additional comments (6)
docs-v2/pages/pricing/index.mdx (6)
5-8: Strong intro clarifies prototyping goals
The updated opening paragraph effectively communicates that users can prototype for free and highlights community contributions.
11-13: Updated Free plan header and description
Renaming to “Free plan” and clarifying the features and limitations under this section enhances consistency and readability.
111-111: Subsections correctly use headings
Introducing#### Source credit usage,#### Included credits,#### Additional credits, and#### Data store keysimproves navigation by clearly segmenting related billing topics.Also applies to: 144-152
160-168: Managing plan and billing period sections
The “Managing your plan” header and its nested “Billing period” subsection are now well-placed and clearly explain how billing cycles work.
174-186: Upgrade, downgrade, and cancellation instructions
Separate headings for “Upgrading”, “Downgrading”, and “Cancelling your plan” enhance clarity and help users find management actions quickly.
192-192: Detailed pricing information section added
Adding a “Detailed pricing information” section header directs readers to the main pricing page for deeper dives—good layout refinement.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs-v2/pages/pricing/index.mdx (3)
79-79: Convert bold label to heading
Switch this from**Scenarios**to a proper subheading (e.g.,#### Scenarios) for consistency.
89-89: Convert bold label to heading
Replace**Workflow segments configured to use 256MB memory (default)**with a heading (e.g.,##### Workflow segments configured to use 256MB memory (default)).
100-100: Convert bold label to heading
Replace**Workflow segments configured to use 1GB memory**with a heading (e.g.,##### Workflow segments configured to use 1GB memory).
🧹 Nitpick comments (3)
docs-v2/pages/pricing/index.mdx (3)
5-7: Consider splitting this introductory section for readability
The two sentences cover distinct ideas (free usage vs. sharing components) and are quite long. Breaking them into shorter paragraphs will improve clarity and focus.
15-23: Convert bold labels into proper subheadings
Instead of using**General:**,**Connect:**, and**Workflows:**, switch to heading syntax (e.g.,#### General,#### Connect,#### Workflows) for better document structure and accessibility.- **General:** + #### General ... - **Connect:** + #### Connect ... - **Workflows:** + #### Workflows
26-26: Use relative links for internal navigation
Change the absolute URL to a site-relative path for consistency and easier maintenance:- To lift the daily credit limit, access additional features, or use Connect in production, [upgrade to a paid plan](https://pipedream.com/pricing). + To lift the daily credit limit, access additional features, or use Connect in production, [upgrade to a paid plan](/pricing).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs-v2/pages/pricing/index.mdx(5 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/pricing/index.mdx
[misspelling] ~168-~168: Did you mean “you're” (short for ‘you are’)?
Context: ...users are tied to a billing period. Your billing period starts when you sign up ...
(YOUR)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: validate-links
- GitHub Check: Lint Code Base
🔇 Additional comments (14)
docs-v2/pages/pricing/index.mdx (14)
11-13: Free plan section looks clear
The "## Free plan" heading and introductory sentence effectively communicate the free-plan features and limitations.
28-28: Section heading update
The "## Paid plans" heading is clear and concise.
32-32: Pipedream Connect heading is descriptive
"## Pipedream Connect" appropriately introduces the pricing details for Connect.
34-34: Verify environment variable rendering
Ensure thatprocess.env.PUBLIC_APPSis defined and injected at build time so the placeholder renders correctly in the documentation.
36-37: List items formatting is consistent
The ordered list with bold labels for "API usage" and "End users" is clear and aligns with the Connect pricing explanation.
111-111: Source credit usage heading is clear
The#### Source credit usageheading correctly introduces the section.
144-144: Included credits heading is clear
The#### Included creditsheading accurately labels the content.
148-148: Additional credits heading is clear
The#### Additional creditsheading properly identifies the section.
160-160: Managing your plan heading is clear
The## Managing your planheading effectively introduces plan management details.
166-166: Billing period heading is accurate
The### Billing periodheading correctly categorizes the content.
174-174: Upgrading heading is concise
The### Upgradingheading clearly labels the upgrade instructions.
178-178: Downgrading heading is concise
The### Downgradingheading appropriately introduces the downgrade details.
186-186: Cancelling your plan heading is consistent
The### Cancelling your planheading aligns with the other action sections.
192-192: Detailed pricing information heading is clear
The## Detailed pricing informationheading accurately introduces the final reference.
* Not ready to merge * Connect pricing * Fixing links * Minor cleanup * Update index.mdx
WHY
Summary by CodeRabbit