Update quickstart for managed agent to use the CLI, also changed the …#1118
Open
Aviatorscode2 wants to merge 1 commit into
Open
Update quickstart for managed agent to use the CLI, also changed the …#1118Aviatorscode2 wants to merge 1 commit into
Aviatorscode2 wants to merge 1 commit into
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 agent documentation by migrating the Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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: 2
🧹 Nitpick comments (1)
content/docs/connect/managed-agent/quickstart.mdx (1)
64-69: 💤 Low valueConsider adding periods to bullet points for consistency.
The bullet list items (Name, Identifier, System prompt, Tools, MCP servers, Skills) are not complete sentences but could benefit from periods for consistency with the Novu style guide, which expects bullet points to end with punctuation.
🤖 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/managed-agent/quickstart.mdx` around lines 64 - 69, Update the bullet list containing the items "Name", "Identifier", "System prompt", "Tools", "MCP servers", and "Skills" in quickstart.mdx so each bullet ends with a period for punctuation consistency with the Novu style guide; edit the six list lines to append a trailing period to each item.
🤖 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: In the sentence that currently reads "Delegate the agent logic
entirely to a managed platform such as Cluade Managed Agents..." replace the
misspelled platform name "Cluade Managed Agents" with the correct "Claude
Managed Agents" so the documentation references the proper managed agent
platform name.
- Line 9: The sentence in the Connect docs contains a missing "to": update the
sentence in content/docs/connect/index.mdx (the string starting "Novu Connect
uses the Agent Communication Infrastructure...") to read "to enable you to
interact with your agents across different messaging platforms" by inserting
"to" between "you" and "interact".
---
Nitpick comments:
In `@content/docs/connect/managed-agent/quickstart.mdx`:
- Around line 64-69: Update the bullet list containing the items "Name",
"Identifier", "System prompt", "Tools", "MCP servers", and "Skills" in
quickstart.mdx so each bullet ends with a period for punctuation consistency
with the Novu style guide; edit the six list lines to append a trailing period
to each item.
🪄 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: 2934a6d1-6def-4dee-ab53-56c6f1b5af2c
⛔ 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
|
|
||
| import { Code2, Sparkles, BrainCircuit, Blocks, MessagesSquare, CircleHelp, Zap } from 'lucide-react'; | ||
|
|
||
| Novu Connect uses the [Agent Communication Infrastructure (ACI)](/connect/get-started/what-is-aci), which is the infrastructure layer that handles how agents communicate, to enable you interact with your agents across different messaging platforms. |
Contributor
There was a problem hiding this comment.
Fix grammar: missing "to" in phrase.
The phrase "to enable you interact" is grammatically incorrect.
✏️ Proposed fix
-Novu Connect uses the [Agent Communication Infrastructure (ACI)](/connect/get-started/what-is-aci), which is the infrastructure layer that handles how agents communicate, to enable you interact with your agents across different messaging platforms.
+Novu Connect uses the [Agent Communication Infrastructure (ACI)](/connect/get-started/what-is-aci), which is the infrastructure layer that handles how agents communicate, to enable you to interact with your agents across different messaging platforms.📝 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
| Novu Connect uses the [Agent Communication Infrastructure (ACI)](/connect/get-started/what-is-aci), which is the infrastructure layer that handles how agents communicate, to enable you interact with your agents across different messaging platforms. | |
| Novu Connect uses the [Agent Communication Infrastructure (ACI)](/connect/get-started/what-is-aci), which is the infrastructure layer that handles how agents communicate, to enable you to interact with your agents across different messaging platforms. |
🤖 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 9, The sentence in the Connect docs
contains a missing "to": update the sentence in content/docs/connect/index.mdx
(the string starting "Novu Connect uses the Agent Communication
Infrastructure...") to read "to enable you to interact with your agents across
different messaging platforms" by inserting "to" between "you" and "interact".
|
|
||
| ### 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".
The managed agent platform name is misspelled.
✏️ 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, In the sentence that currently
reads "Delegate the agent logic entirely to a managed platform such as Cluade
Managed Agents..." replace the misspelled platform name "Cluade Managed Agents"
with the correct "Claude Managed Agents" so the documentation references the
proper managed agent platform name.
Contributor
|
This PR is massive. Do you actually want me to review all the files or just a subset? |
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.
Summary by CodeRabbit
Documentation