Adding known limitations #15000
Adding known limitations #15000
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe pull request focuses on improving documentation for Connect workflows and troubleshooting. The changes enhance the clarity and readability of documentation in two key files: Changes
Sequence DiagramsequenceDiagram
participant User
participant Workflow
participant Authentication
participant Support
User->>Workflow: Trigger workflow
Workflow->>Authentication: Validate external user
alt Invalid Authentication
Authentication-->>Workflow: Return error
Workflow-->>User: Display error message
User->>Support: Contact for assistance
else Valid Authentication
Workflow->>Workflow: Execute workflow steps
end
Possibly related PRs
Poem
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? 🪧 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: 0
🧹 Nitpick comments (3)
docs-v2/pages/connect/troubleshooting.mdx (1)
49-51: Consider adding more context to the support contact informationThe Callout component is well-used here, but consider adding more context about what information users should provide when contacting support.
<Callout type="info"> -If you're still have trouble or hitting an error that isn't listed here, [get in touch with us](https://pipedream.com/support). We'd love to help. +If you're still having trouble or encountering an error not listed here, [contact our support team](https://pipedream.com/support). When reaching out, please include: +- The specific error message you're seeing +- Steps to reproduce the issue +- Your workflow ID +We'd love to help! </Callout>docs-v2/pages/connect/workflows.mdx (2)
296-297: Consider adding more details about the Business planWhile the Business plan requirement is clearly stated, users might benefit from knowing more about what's included.
- Schedule a call with our sales team and learn more about pricing [here](https://pipedream.com/pricing?plan=Enterprise). + Schedule a call with our sales team to learn more about: + - Production workflow execution limits + - Enterprise support SLAs + - Custom pricing options + Visit our [pricing page](https://pipedream.com/pricing?plan=Enterprise) for more details.
298-310: LGTM: Clear and comprehensive limitations documentationThe known limitations section effectively communicates current constraints with:
- Clear headings for each limitation
- Detailed explanations of what's not supported
- Alternative approaches where applicable
However, there's a minor style issue in line 301 with the repeated use of "currently".
-Currently, you can only use your end user's auth in the linear execution paths of a Pipedream workflow. +You can only use your end user's auth in the linear execution paths of a Pipedream workflow.🧰 Tools
🪛 LanguageTool
[style] ~301-~301: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...upported within control flow segments - Currently, you can only use your end user's auth ...(ADVERB_REPETITION_PREMIUM)
📜 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 (2)
docs-v2/pages/connect/troubleshooting.mdx(2 hunks)docs-v2/pages/connect/workflows.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/troubleshooting.mdx
[style] ~39-~39: As a shorter alternative for ‘able to’, consider using “can only”.
Context: ... try again. Connect tokens expire, and are only able to be used once. Try generating a new toke...
(BE_ABLE_TO)
[style] ~39-~39: Avoid the passive voice after ‘to be able to’.
Context: ...ect tokens expire, and are only able to be used once. Try generating a new token and tr...
(ABLE_TO_PASSIVE)
docs-v2/pages/connect/workflows.mdx
[style] ~301-~301: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...upported within control flow segments - Currently, you can only use your end user's auth ...
(ADVERB_REPETITION_PREMIUM)
🔇 Additional comments (3)
docs-v2/pages/connect/troubleshooting.mdx (2)
1-2: LGTM: Clean import statement addition
The Callout component import is properly placed at the top of the file and will be used later in the document.
9-9: LGTM: Improved error message formatting
The error messages are now consistently formatted using blockquotes, which improves readability and makes them stand out from the surrounding text.
Also applies to: 19-21, 37-37
docs-v2/pages/connect/workflows.mdx (1)
Line range hint 280-296: LGTM: Well-structured error documentation
The common errors section is well-organized with clear descriptions and solutions for each error case. The structure makes it easy for users to identify and resolve their specific issues.
1 participant
WHY
Summary by CodeRabbit