Updating /docs-v2 and /mcp readmes #17566
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Caution Review failedThe pull request is closed. WalkthroughA deprecation warning was added to the top of the docs-v2 README and as a predev script in its package.json. The modelcontextprotocol README was updated to reflect support for over 2,700 apps, clarify documentation focus, and refine demo site descriptions. References to unavailable dynamic code were replaced with pointers to relevant documentation. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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)
modelcontextprotocol/README.md (2)
3-3: Grammar tweak improves readability
The coordination “and is powered by” doesn’t agree with the singular subject.-This is a reference implementation of the Pipedream MCP server. You can run **your own MCP server** for [over 2,700 apps and APIs](https://pipedream.com/apps) and is powered by [Pipedream Connect](https://pipedream.com/docs/connect/). +This is a reference implementation of the Pipedream MCP server. You can run **your own MCP server** for [over 2,700 apps and APIs](https://pipedream.com/apps), powered by [Pipedream Connect](https://pipedream.com/docs/connect/).
5-7: Inconsistent “note” call-out formatting
Line 5 uses[Note], while line 65 switches to[!NOTE], which GitHub Markdown doesn’t render. Pick one style for consistency (prefer the simpler[Note]).-> [!NOTE] > [Check out the docs](https://pipedream.com/docs/connect/mcp/app-discovery) to learn more about enabling app discovery with the MCP server. +> [Note] +> [Check out the docs](https://pipedream.com/docs/connect/mcp/app-discovery) to learn more about enabling app discovery with the MCP server.Also applies to: 65-65
docs-v2/README.md (1)
3-8: Provide the actual new docs location
Telling contributors to “contact the team” slows them down. Link directly to the new repo / site if possible.-> The documentation has been moved to a new location. Please contact the team for the current documentation repository. +> The documentation has been moved to [pipedream.com/docs](https://pipedream.com/docs). Please use that source for all updates.
📜 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 (3)
docs-v2/README.md(1 hunks)docs-v2/package.json(1 hunks)modelcontextprotocol/README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
docs-v2/README.md (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
docs-v2/package.json (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
🪛 LanguageTool
docs-v2/README.md
[style] ~6-~6: Consider shortening or rephrasing this to strengthen your wording.
Context: ...rectory is no longer maintained. Do not make changes to files in this directory as they will no...
(MAKE_CHANGES)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: pnpm publish
- GitHub Check: Lint Code Base
🔇 Additional comments (1)
modelcontextprotocol/README.md (1)
13-14: Nice clarification of demo sites
Clear difference between consumer-facing and developer-facing demos helps newcomers.
docs-v2/package.json
Outdated
| "description": "Pipedream docs", | ||
| "private": true, | ||
| "scripts": { | ||
| "predev": "echo '\\n⚠️ WARNING: This docs-v2 project is DEPRECATED!\\n⚠️ Do not commit changes to this directory.\\n⚠️ The documentation has moved to a new location.\\n' && sleep 3", |
There was a problem hiding this comment.
🛠️ Refactor suggestion
echo escape sequences won’t render newlines on many shells
Without -e, the \n literals are printed verbatim, and Windows’ cmd lacks sleep.
- "predev": "echo '\\n⚠️ WARNING: This docs-v2 project is DEPRECATED!\\n⚠️ Do not commit changes to this directory.\\n⚠️ The documentation has moved to a new location.\\n' && sleep 3",
+ "predev": "printf '\\n⚠️ WARNING: This docs-v2 project is DEPRECATED!\\n⚠️ Do not commit changes to this directory.\\n⚠️ The documentation has moved to a new location.\\n\\n' ; node -e \"setTimeout(()=>{},3000)\"",This keeps the warning cross-platform and avoids relying on *nix-only utilities.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs-v2/package.json at line 7, the predev script uses echo with \n escape
sequences which do not render newlines on many shells and uses sleep which is
not available on Windows cmd. Replace the echo command with multiple echo
statements or a cross-platform method to print newlines properly, and remove or
replace sleep with a cross-platform alternative to ensure the warning message
displays correctly on all platforms.
WHY
Summary by CodeRabbit