small rev to docs

[dannyroosevelt]

WHY

Summary by CodeRabbit

• Documentation
  • Standardized environment variable usage in API examples by replacing hardcoded values with placeholders.
  • Updated JSON payload examples to correctly structure properties for component actions and trigger deployments.
  • Revised section headings and wording for clarity.
  • Added a "Known gaps and limitations" section outlining current limitations.
  • Renamed "Resources" to "Additional resources" and added a new resource link.
  • Corrected minor typos and improved wording in security callouts.

[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	Apr 16, 2025 7:46pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Apr 16, 2025 7:46pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Apr 16, 2025 7:46pm

[coderabbitai]

Walkthrough

The documentation has been updated to standardize API example headers by replacing hardcoded environment values with placeholders and to correct the structure of JSON payloads in cURL examples, specifically for component configuration and deployment. Additionally, the documentation for MCP now features revised security wording, the addition of a "Known gaps and limitations" section, renaming of the "Resources" section, and the inclusion of a new resource link. These changes are limited to documentation content and do not affect any code or exported entities.

Changes

File(s)	Change Summary
docs-v2/pages/connect/components.mdx	Replaced hardcoded environment header values with placeholders in cURL examples; updated JSON payloads to move projectId into configured_props; removed "prop_name": "projectId"; minor heading adjustment in "Configure dynamic props".
docs-v2/pages/connect/mcp.mdx	Revised security callout wording; added "Known gaps and limitations" section; renamed "Resources" to "Additional resources"; added new resource link; fixed a URL typo.

Poem

In docs we hop, with headers anew,
Placeholders bloom where hardcodes once grew.
Payloads restructured, examples refined,
Limitations listed, resources aligned.
A rabbit’s delight in clarity’s quest—
With every small edit, our docs are their best!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 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 c37db1c and 17d7082.

📒 Files selected for processing (2)

• docs-v2/pages/connect/components.mdx (7 hunks)
• docs-v2/pages/connect/mcp.mdx (2 hunks)

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

• GitHub Check: Lint Code Base
• GitHub Check: validate-links

🔇 Additional comments (12)

docs-v2/pages/connect/components.mdx (9)

147-147: Consistent use of environment placeholder in cURL examples
Replaced hardcoded development header value with {environment} placeholder for clarity and reusability.

---

242-242: Standardize environment header placeholder
Updated the X-PD-Environment header in the “Retrieve the component’s definition” example to use {environment}.

---

350-350: Use {environment} placeholder in configuration call
Ensures consistency by replacing the static environment string with the {environment} placeholder in the configuration example.

---

453-453: Remove unnecessary “(optional)” from heading
Simplifies the “Configure dynamic props” section title by dropping redundant “(optional)”.

---

620-620: Placeholder for environment header in action invocation
Updated the action run cURL snippet to use X-PD-Environment: {environment} for consistency across all examples.

---

628-629: Move projectId into configured_props object
Correctly nests the projectId property under configured_props and removes the old prop_name field, matching the API spec.

---

715-716: Correct JSON structure in Node.js deployTrigger call
Ensures projectId is moved inside configuredProps, aligning with the updated API payload structure.

---

734-734: Consistent environment header in deployTrigger cURL
Replaced the hardcoded environment with the {environment} placeholder in the deploy-trigger example.

---

742-743: Fix payload nesting for projectId in cURL deploy-trigger example
Relocates projectId under configured_props and removes the obsolete prop_name parameter.

docs-v2/pages/connect/mcp.mdx (3)

19-19: Clarify security callout to emphasize encryption and server-side handling
Updated the security note to focus on encryption at rest and server-side request handling, removing outdated OAuth credential wording.

---

173-176: Add “Known gaps and limitations” section
Clearly outlines current limitations around dynamic props support and per-app server provisioning for MCP, aiding user expectations.

---

183-188: Rename and enrich resources section
Renamed “Resources” to “Additional resources” and added a direct link to hosted MCP servers for quick access.

---

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.

❤️ 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.
• @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.