This repository was archived by the owner on Jun 26, 2026. It is now read-only.
Update content to change language to client-facing, update quickstart - #1125
Merged
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis PR reorganizes the agents documentation section by clarifying ACI's role as a communication infrastructure layer, introducing a new landing page for agents, and updating the managed agent quickstart from a dashboard-based to CLI-based flow. The ACI definition page was rewritten to explain how messages are normalized, identities resolved, conversations persisted, and responses delivered. A new agents index page serves as the entry point, explaining the infrastructure vs. intelligence boundary and providing navigation cards. The managed agent quickstart was completely revised to guide users through the Novu CLI ( Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/docs/agents/get-started/what-is-aci.mdx (1)
127-127:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse consistent product/channel capitalization for Slack.
Line 127 uses “slack provider” while the rest of the page uses “Slack provider.” Please standardize to “Slack” for consistency.
🤖 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/agents/get-started/what-is-aci.mdx` at line 127, The phrase "slack provider" in the sentence "Create your first agent, connect a slack provider, and send a message in under 5 minutes." should be capitalized to "Slack provider" to match the rest of the document; update that exact string in content/docs/agents/get-started/what-is-aci.mdx so all occurrences use "Slack" consistently.
🤖 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/agents/get-started/what-is-aci.mdx`:
- Line 90: Update the pluralization in the sentence that currently reads "The
agent's tools, skill and their configuration" in
content/docs/agents/get-started/what-is-aci.mdx by changing "skill" to "skills"
so it reads "The agent's tools, skills and their configuration"; locate the
sentence by searching for the exact phrase "The agent's tools, skill and their
configuration" and make the single-word fix.
In `@content/docs/agents/index.mdx`:
- Around line 26-29: Remove the duplicated introductory sentence so only one of
the two similar lines remains; specifically, keep a single sentence that reads
either "Novu Connect accepts two kinds of agents. You choose how you want to
bring the intelligence." or "Novu Connect accepts two kinds of agent brains. You
choose how you want to bring the intelligence." and delete the other duplicate
occurrence to eliminate redundancy in the agents/agent brains intro.
---
Outside diff comments:
In `@content/docs/agents/get-started/what-is-aci.mdx`:
- Line 127: The phrase "slack provider" in the sentence "Create your first
agent, connect a slack provider, and send a message in under 5 minutes." should
be capitalized to "Slack provider" to match the rest of the document; update
that exact string in content/docs/agents/get-started/what-is-aci.mdx so all
occurrences use "Slack" consistently.
🪄 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: 6c9549ae-b345-4232-afb6-028361b76b3e
⛔ Files ignored due to path filters (1)
public/images/agents/quickstart/novu-connect-demo.gifis excluded by!**/*.gif
📒 Files selected for processing (5)
content/docs/agents/get-started/what-is-aci.mdxcontent/docs/agents/index.mdxcontent/docs/agents/managed-agent/quickstart.mdxcontent/docs/agents/meta.jsonsrc/middleware.ts
💤 Files with no reviewable changes (1)
- src/middleware.ts
DianaHackmamba
suggested changes
Jun 11, 2026
|
|
||
| Click **Create Agent** when you are done. | ||
| ## Create an agent | ||
|
|
Contributor
There was a problem hiding this comment.
Add context paragraph?
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Address DianaHackmamba's review comments on PR #1125: convert channel lists to bullet lists, remove duplicate paragraph, trim verbose CLI option explanations, and drop passive "will" phrasing. Add an "Agent brain" glossary entry and link to it from the agents overview instead of defining it inline. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
jainpawan21
approved these changes
Jun 23, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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
/agents→what-is-acimapping.Greptile Summary
This PR rewrites the agents documentation with client-facing language, adds a new
/agentsoverview page (index.mdx), updates the managed agent quickstart to use the Novu CLI (npx novu connect), and removes the now-redundant/agents→what-is-acimiddleware redirect.index.mdx: Serves as the/agentslanding page, explaining ACI's two concerns (communication infrastructure vs. agent intelligence) and providing entry points to both the managed agent and custom code agent paths.what-is-aci.mdxrefresh: Replaces technical jargon with product-oriented language and restructures the three-part architecture explanation with bullet-list channel enumerations.Confidence Score: 5/5
Safe to merge — only documentation and a single redirect removal; no runtime logic is introduced.
All code changes are documentation content and a one-line redirect removal. The middleware change is safe:
/agentsis covered byMARKDOWN_SECTIONSso the catch-all redirect never fires, andindex.mdxnow correctly serves that route. The only new finding is a minor cross-link inconsistency in the "Start building" section ofwhat-is-aci.mdx.The "Start building" Quickstart card in
what-is-aci.mdxstill points to the custom code agent path while the new overview page promotes the managed agent CLI path — worth aligning before merge.Important Files Changed
npx novu connect) flow; Slack token instructions are accurate. "Send a message" step is coupled to the engineering-assistant example description (flagged in a previous review). Missing trailing newline (flagged in previous review)./agents→what-is-aciredirect; safe because/agentsis already listed in MARKDOWN_SECTIONS so the catch-all platform-prefix redirect does not fire, and index.mdx now serves the route directly.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[User visits /agents] --> B{New index.mdx} B --> C[Overview: ACI explained] C --> D{Choose agent type} D --> E[Managed Agent\n/agents/managed-agent/quickstart] D --> F[Custom Code Agent\n/agents/custom-code-agent/quickstart] E --> G[npx novu connect] G --> H[Select: Demo credentials\nor Claude Managed Agents] H --> I[Describe agent] I --> J[Connect Slack\nSlack App Config Token] J --> K[Agent live in Slack] K --> L[Send DM to bot] L --> M[Reply via ACI bridge] M --> N[Persisted in Connect dashboard]%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A[User visits /agents] --> B{New index.mdx} B --> C[Overview: ACI explained] C --> D{Choose agent type} D --> E[Managed Agent\n/agents/managed-agent/quickstart] D --> F[Custom Code Agent\n/agents/custom-code-agent/quickstart] E --> G[npx novu connect] G --> H[Select: Demo credentials\nor Claude Managed Agents] H --> I[Describe agent] I --> J[Connect Slack\nSlack App Config Token] J --> K[Agent live in Slack] K --> L[Send DM to bot] L --> M[Reply via ACI bridge] M --> N[Persisted in Connect dashboard]Reviews (4): Last reviewed commit: "Update index file" | Re-trigger Greptile