-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Small update to docs #16719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Small update to docs #16719
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation was updated to standardize the environment variable name from Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs-v2/pages/connect/mcp/openai.mdx (2)
5-5: Fix typo in “capabilities.”The word “capabilties” is misspelled. Please correct it to “capabilities” for clarity.
- Access {process.env.PUBLIC_APPS}+ APIs and 10,000+ tools in OpenAI using Pipedream MCP with the [OpenAI Responses API](https://platform.openai.com/docs/guides/tools?api-mode=responses). MCP makes it easy to extend the capabilties of any LLM or agent, and Pipedream offers drop-in support for OpenAI. + Access {process.env.PUBLIC_APPS}+ APIs and 10,000+ tools in OpenAI using Pipedream MCP with the [OpenAI Responses API](https://platform.openai.com/docs/guides/tools?api-mode=responses). MCP makes it easy to extend the capabilities of any LLM or agent, and Pipedream offers drop-in support for OpenAI.
68-68: Bracket indentation—nitpick.Consider aligning the closing brace
},under its opening brace for consistency with surrounding JavaScript formatting:- "Authorization": `Bearer ${token}` - }, + "Authorization": `Bearer ${token}`, + },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (3)
docs-v2/pages/connect/managed-auth/quickstart.mdx(1 hunks)docs-v2/pages/connect/mcp/developers.mdx(1 hunks)docs-v2/pages/connect/mcp/openai.mdx(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (6)
docs-v2/pages/connect/managed-auth/quickstart.mdx (1)
47-47: Consistent environment variable rename—looks good.The environment variable has been correctly updated from
PIPEDREAM_PROJECT_ENVIRONMENTtoPIPEDREAM_ENVIRONMENT. This aligns with the rest of the docs and the underlying SDK.docs-v2/pages/connect/mcp/developers.mdx (1)
26-26: Environment variable rename is correct.Updating
PIPEDREAM_PROJECT_ENVIRONMENTtoPIPEDREAM_ENVIRONMENTensures consistency with other Quickstart guides.docs-v2/pages/connect/mcp/openai.mdx (4)
8-8: Verify the account-connection anchor.You’ve updated the callout to link to
#account-connection. Ensure this matches the “Account Connection” heading slug generated by MDX so the in-page link resolves correctly.
30-30: Environment variable rename applied correctly.The change from
PIPEDREAM_PROJECT_ENVIRONMENTtoPIPEDREAM_ENVIRONMENTin the bash snippet is consistent and aligns with the SDK usage in examples above.
35-36: Tabs configuration updated—approved.Limiting the tabs to
['JavaScript', 'cURL']and removing the Python example streamlines the guide.
80-126: cURL snippet detailed steps—good to go.The three-step cURL example is clear, and the
X-PD-Environment: $PIPEDREAM_ENVIRONMENTheader uses the updated variable name.
WHY
Summary by CodeRabbit
PIPEDREAM_ENVIRONMENTfor consistency.