Update quickstart for managed agent #1120
Open
DianaHackmamba wants to merge 1 commit into
Open
Conversation
…route from https://docs.novu.co/agents to https://docs.novu.co/connect and also created a landing page for the Novu connect
|
PR author is not in the allowed authors list. |
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis PR restructures Novu's documentation by migrating the Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/docs/connect/index.mdx (1)
54-56: ⚡ Quick winConsider differentiating the quickstart descriptions.
The descriptions for both the managed agent quickstart (lines 54-55) and custom code agent quickstart (lines 75-76) are identical: "Connect a Slack provider and send your first message in under 5 minutes." While both are quickstarts, differentiating these descriptions would help readers understand the key difference between the two approaches at a glance.
For example:
- Managed agent: "Set up a Claude-powered agent and send your first message in under 5 minutes."
- Custom code agent: "Build your own agent with custom code and connect to Slack in under 5 minutes."
Also applies to: 75-77
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/docs/connect/index.mdx` around lines 54 - 56, The two Card descriptions are identical; update the description text for the Card with href="/connect/managed-agent/quickstart" (title "Quickstart") to something like "Set up a Claude-powered agent and send your first message in under 5 minutes." and update the Card for the custom code quickstart (the Card with href="/connect/custom-agent/quickstart" or the second quickstart Card in this file) to something like "Build your own agent with custom code and connect to Slack in under 5 minutes." Ensure you only change the inner text of those Card components so the titles/links remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@content/docs/connect/index.mdx`:
- Line 28: Fix the typo in the text "Cluade Managed Agents" by replacing it with
"Claude Managed Agents" wherever it appears (specifically the sentence that
starts "Delegate the agent logic entirely to a managed platform such as Cluade
Managed Agents."); update the string to "Claude Managed Agents" to correct
spelling and ensure consistent usage across the document.
---
Nitpick comments:
In `@content/docs/connect/index.mdx`:
- Around line 54-56: The two Card descriptions are identical; update the
description text for the Card with href="/connect/managed-agent/quickstart"
(title "Quickstart") to something like "Set up a Claude-powered agent and send
your first message in under 5 minutes." and update the Card for the custom code
quickstart (the Card with href="/connect/custom-agent/quickstart" or the second
quickstart Card in this file) to something like "Build your own agent with
custom code and connect to Slack in under 5 minutes." Ensure you only change the
inner text of those Card components so the titles/links remain unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: bc483baa-4ce1-4233-8668-54aa61edf8ec
⛔ Files ignored due to path filters (2)
public/images/agents/managed-agent/agent-message-slack.pngis excluded by!**/*.pngpublic/images/agents/managed-agent/novu-connect-demo.gifis excluded by!**/*.gif
📒 Files selected for processing (37)
content/docs/agents/managed-agent/quickstart.mdxcontent/docs/connect/conversations.mdxcontent/docs/connect/custom-code-agent/build-your-first-agent.mdxcontent/docs/connect/custom-code-agent/concepts.mdxcontent/docs/connect/custom-code-agent/going-to-production.mdxcontent/docs/connect/custom-code-agent/meta.jsoncontent/docs/connect/custom-code-agent/quickstart.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/connect-components.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/connect-components.model.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/create-an-agent.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/handle-events.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/meta.jsoncontent/docs/connect/custom-code-agent/setup-your-agent/overview.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/reply.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/scaffold-your-project.mdxcontent/docs/connect/custom-code-agent/setup-your-agent/signals.mdxcontent/docs/connect/get-started/agents-and-providers.mdxcontent/docs/connect/get-started/mental-model.mdxcontent/docs/connect/get-started/meta.jsoncontent/docs/connect/get-started/what-is-aci.mdxcontent/docs/connect/index.mdxcontent/docs/connect/managed-agent/add-skills.mdxcontent/docs/connect/managed-agent/concepts.mdxcontent/docs/connect/managed-agent/configure-mcp-servers.mdxcontent/docs/connect/managed-agent/meta.jsoncontent/docs/connect/managed-agent/overview.mdxcontent/docs/connect/managed-agent/quickstart.mdxcontent/docs/connect/meta.jsoncontent/docs/meta.jsoncontent/docs/platform/integrations/chat/(providers)/ms-teams.mdxcontent/docs/platform/integrations/chat/(providers)/slack.mdxcontent/docs/platform/integrations/chat/(providers)/whats-app.mdxcontent/docs/platform/integrations/chat/index.mdxnext.config.mjssrc/app/layout.config.tsxsrc/middleware.ts
💤 Files with no reviewable changes (1)
- content/docs/agents/managed-agent/quickstart.mdx
|
|
||
| ### External connectors | ||
|
|
||
| Delegate the agent logic entirely to a managed platform such as Cluade Managed Agents. You configure the agent's behavior, system prompt, tools, skills, and MCP servers and the platform runs the intelligence. |
Contributor
There was a problem hiding this comment.
Fix typo: "Cluade" should be "Claude".
Line 28 contains a typo: "Cluade Managed Agents" should be "Claude Managed Agents".
✏️ Proposed fix
-Delegate the agent logic entirely to a managed platform such as Cluade Managed Agents. You configure the agent's behavior, system prompt, tools, skills, and MCP servers and the platform runs the intelligence.
+Delegate the agent logic entirely to a managed platform such as Claude Managed Agents. You configure the agent's behavior, system prompt, tools, skills, and MCP servers and the platform runs the intelligence.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Delegate the agent logic entirely to a managed platform such as Cluade Managed Agents. You configure the agent's behavior, system prompt, tools, skills, and MCP servers and the platform runs the intelligence. | |
| Delegate the agent logic entirely to a managed platform such as Claude Managed Agents. You configure the agent's behavior, system prompt, tools, skills, and MCP servers and the platform runs the intelligence. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@content/docs/connect/index.mdx` at line 28, Fix the typo in the text "Cluade
Managed Agents" by replacing it with "Claude Managed Agents" wherever it appears
(specifically the sentence that starts "Delegate the agent logic entirely to a
managed platform such as Cluade Managed Agents."); update the string to "Claude
Managed Agents" to correct spelling and ensure consistent usage across the
document.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This whole quickstart needs more explanation. Tell me (the reader) what is in it for me, what the agent will do, and how it will help me. Get me excited about what I am going to build!
Summary by CodeRabbit
Release Notes