Skip to content

Update quickstart for managed agent to use the CLI, also changed the … #1118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Aviatorscode2 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update quickstart for managed agent to use the CLI, also changed the … #1118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 0 additions & 115 deletions content/docs/agents/managed-agent/quickstart.mdx
View file
Open in desktop

This file was deleted.

0 content/docs/agents/conversations.mdx → content/docs/connect/conversations.mdx
View file
Open in desktop
File renamed without changes.
16 changes: 8 additions & 8 deletions ...tom-code-agent/build-your-first-agent.mdx → ...tom-code-agent/build-your-first-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

This walkthrough builds a small support bot for a fake product called Pipelinr. You add one piece at a time in `support-agent.tsx` until the bot greets users, routes by topic, answers with an LLM, and resolves the thread when the user is done.

For API reference, see [Handle events](/agents/custom-code-agent/setup-your-agent/handle-events), [Reply](/agents/custom-code-agent/setup-your-agent/reply), and [Signals](/agents/custom-code-agent/setup-your-agent/signals).
For API reference, see [Handle events](/connect/custom-code-agent/setup-your-agent/handle-events), [Reply](/connect/custom-code-agent/setup-your-agent/reply), and [Signals](/connect/custom-code-agent/setup-your-agent/signals).

## What you're building

Expand Down Expand Up @@ -107,7 +107,7 @@
- Returning JSX is shorthand for `await ctx.reply(...)`.
- Each `Button` has an `id` and `value` used in `onAction`.

For all card components, see [Interactive cards](/agents/custom-code-agent/setup-your-agent/reply#interactive-cards).
For all card components, see [Interactive cards](/connect/custom-code-agent/setup-your-agent/reply#interactive-cards).

</Step>

Expand All @@ -129,7 +129,7 @@
});
```

Read it back with `ctx.metadata.get('topic')` on the next message. To alert on-call for technical issues, use `ctx.trigger`. For details, see [Trigger a workflow](/agents/custom-code-agent/setup-your-agent/signals#trigger-a-workflow).
Read it back with `ctx.metadata.get('topic')` on the next message. To alert on-call for technical issues, use `ctx.trigger`. For details, see [Trigger a workflow](/connect/custom-code-agent/setup-your-agent/signals#trigger-a-workflow).

</Step>

Expand Down Expand Up @@ -169,7 +169,7 @@
```

- `ctx.history` maps directly to SDK message format.
- For files in replies, use `ctx.reply` with the `files` option. For details, see [Sending attachments](/agents/custom-code-agent/setup-your-agent/reply#sending-attachments).
- For files in replies, use `ctx.reply` with the `files` option. For details, see [Sending attachments](/connect/custom-code-agent/setup-your-agent/reply#sending-attachments).

Check warning on line 172 in content/docs/connect/custom-code-agent/build-your-first-agent.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/connect/custom-code-agent/build-your-first-agent.mdx#L172 

[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
Raw output 
{"message": "[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).", "location": {"path": "content/docs/connect/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 172, "column": 1}}}, "severity": "WARNING"}

</Step>

Expand Down Expand Up @@ -265,16 +265,16 @@
<Card icon={<Brain />} href="https://sdk.vercel.ai/docs/foundations/tools" title="Give the model real context">
Add RAG or tool calls so the model can query your API or docs.
</Card>
<Card icon={<ThumbsUp />} href="/agents/custom-code-agent/setup-your-agent/handle-events#onreaction" title="Capture reactions">
<Card icon={<ThumbsUp />} href="/connect/custom-code-agent/setup-your-agent/handle-events#onreaction" title="Capture reactions">
Add `onReaction` for thumbs-up/down feedback.
</Card>
<Card icon={<Mail />} href="/agents/custom-code-agent/setup-your-agent/signals#trigger-a-workflow" title="Send a CSAT email">
<Card icon={<Mail />} href="/connect/custom-code-agent/setup-your-agent/signals#trigger-a-workflow" title="Send a CSAT email">

Check notice on line 271 in content/docs/connect/custom-code-agent/build-your-first-agent.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/connect/custom-code-agent/build-your-first-agent.mdx#L271 

[Google.Acronyms] Spell out 'CSAT', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'CSAT', if it's unfamiliar to the audience.", "location": {"path": "content/docs/connect/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 271, "column": 117}}}, "severity": "INFO"}
Use `ctx.trigger` after resolution for a follow-up survey workflow.
</Card>
<Card icon={<LayoutGrid />} href="/agents/custom-code-agent/setup-your-agent/reply#interactive-cards" title="Build richer cards">
<Card icon={<LayoutGrid />} href="/connect/custom-code-agent/setup-your-agent/reply#interactive-cards" title="Build richer cards">
Dropdowns, links, text inputs, and multi-action cards.
</Card>
<Card icon={<Rocket />} href="/agents/custom-code-agent/going-to-production" title="Going to production">
<Card icon={<Rocket />} href="/connect/custom-code-agent/going-to-production" title="Going to production">
Run locally, deploy to development, and publish to production.
</Card>
</Cards>
4 changes: 2 additions & 2 deletions ...ocs/agents/custom-code-agent/concepts.mdx → ...cs/connect/custom-code-agent/concepts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,10 @@ The same handler code works on every connected provider; adding a provider does
## Next steps

<Cards>
<Card icon={<HomeIcon />} href="/agents/custom-code-agent/quickstart" title="Quickstart">
<Card icon={<HomeIcon />} href="/connect/custom-code-agent/quickstart" title="Quickstart">
Create an agent, connect Slack, and get a reply in-thread.
</Card>
<Card icon={<BrainIcon />} href="/agents/custom-code-agent/build-your-first-agent" title="Build your first agent">
<Card icon={<BrainIcon />} href="/connect/custom-code-agent/build-your-first-agent" title="Build your first agent">
Walk through a full support-bot handler file.
</Card>
</Cards>
4 changes: 2 additions & 2 deletions ...custom-code-agent/going-to-production.mdx → ...custom-code-agent/going-to-production.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ After you run the command, the agent overview section shows the updated producti

#### Using GitHub Actions

You can use our built-in GitHub Action to deploy your agent to the production environment. See [Deploy with GitHub Actions](/agents/operate/deploy-with-github-actions) for setup details.
You can use our built-in GitHub Action to deploy your agent to the production environment. See [Deploy with GitHub Actions](/connect/operate/deploy-with-github-actions) for setup details.

```yaml
name: Deploy agent to Novu Cloud
Expand Down Expand Up @@ -115,7 +115,7 @@ jobs:
## Next steps

<Cards>
<Card icon={<MessagesSquare />} href="/agents/conversations" title="Conversation observability">
<Card icon={<MessagesSquare />} href="/connect/conversations" title="Conversation observability">
View agent conversations, lifecycle, and signal activity in the dashboard.
</Card>
</Cards>
0 ...t/docs/agents/custom-code-agent/meta.json → .../docs/connect/custom-code-agent/meta.json
View file
Open in desktop
File renamed without changes.
12 changes: 6 additions & 6 deletions ...s/agents/custom-code-agent/quickstart.mdx → .../connect/custom-code-agent/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ npx novu@latest init -t agent \
--api-url=<NOVU_API_URL>
```

Run it in the directory where you want the project. See [Scaffold your project](/agents/custom-code-agent/setup-your-agent/scaffold-your-project) for details.
Run it in the directory where you want the project. See [Scaffold your project](/connect/custom-code-agent/setup-your-agent/scaffold-your-project) for details.

</Step>

Expand All @@ -119,7 +119,7 @@ Message your bot in Slack. Your `onMessage` handler runs and the reply appears i

![Slack message](/images/agents/quickstart/slack-message.png)

Edit files in `app/novu/agents/` to customize behavior. See [Handle events](/agents/custom-code-agent/setup-your-agent/handle-events) for all event types.
Edit files in `app/novu/agents/` to customize behavior. See [Handle events](/connect/custom-code-agent/setup-your-agent/handle-events) for all event types.

</Step>

Expand All @@ -128,16 +128,16 @@ Edit files in `app/novu/agents/` to customize behavior. See [Handle events](/age
## Next steps

<Cards>
<Card icon={<MousePointerClick />} href="/agents/custom-code-agent/setup-your-agent/handle-events" title="Handle events">
<Card icon={<MousePointerClick />} href="/connect/custom-code-agent/setup-your-agent/handle-events" title="Handle events">
Respond to actions, reactions, and resolution events.
</Card>
<Card icon={<LayoutGrid />} href="/agents/custom-code-agent/setup-your-agent/reply" title="Reply">
<Card icon={<LayoutGrid />} href="/connect/custom-code-agent/setup-your-agent/reply" title="Reply">
Markdown, attachments, and interactive cards.
</Card>
<Card icon={<Signal />} href="/agents/custom-code-agent/setup-your-agent/signals" title="Signals">
<Card icon={<Signal />} href="/connect/custom-code-agent/setup-your-agent/signals" title="Signals">
Metadata, workflow triggers, and conversation resolution.
</Card>
<Card icon={<Brain />} href="/agents/custom-code-agent/build-your-first-agent" title="Build your first agent">
<Card icon={<Brain />} href="/connect/custom-code-agent/build-your-first-agent" title="Build your first agent">
Full support-bot walkthrough with an LLM.
</Card>
</Cards>
4 changes: 2 additions & 2 deletions ...t/setup-your-agent/connect-components.mdx → ...t/setup-your-agent/connect-components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ export default SlackConnectButtonComponent;
## Related

<Cards>
<Card icon={<Plus />} href="/agents/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
<Card icon={<Plus />} href="/connect/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
Create an agent in the Novu dashboard and connect a provider.
</Card>
<Card icon={<Zap />} href="/agents/custom-code-agent/quickstart" title="Quickstart">
<Card icon={<Zap />} href="/connect/custom-code-agent/quickstart" title="Quickstart">
Create an agent, connect Slack, and get a reply in-thread.
</Card>
</Cards>
4 changes: 2 additions & 2 deletions ...p-your-agent/connect-components.model.mdx → ...p-your-agent/connect-components.model.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ export default SlackConnectButtonComponent;
## Related

<Cards>
<Card icon={<Plus />} href="/agents/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
<Card icon={<Plus />} href="/connect/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
Create an agent in the Novu dashboard and connect a provider.
</Card>
<Card icon={<Zap />} href="/agents/custom-code-agent/quickstart" title="Quickstart">
<Card icon={<Zap />} href="/connect/custom-code-agent/quickstart" title="Quickstart">
Create an agent, connect Slack, and get a reply in-thread.
</Card>
</Cards>
8 changes: 4 additions & 4 deletions ...gent/setup-your-agent/create-an-agent.mdx → ...gent/setup-your-agent/create-an-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ On the guided setup page in the Novu dashboard, link your agent to a messaging p
1. In the **Select provider** list, choose a provider (for example, **Slack**).
2. Follow the provider-specific steps shown in the dashboard.

For a full Slack walkthrough including app creation and install, see [Quickstart](/agents/custom-code-agent/quickstart).
For a full Slack walkthrough including app creation and install, see [Quickstart](/connect/custom-code-agent/quickstart).

## Related

<Cards>
<Card icon={<Terminal />} href="/agents/custom-code-agent/setup-your-agent/scaffold-your-project" title="Scaffold your project">
<Card icon={<Terminal />} href="/connect/custom-code-agent/setup-your-agent/scaffold-your-project" title="Scaffold your project">
Generate a bridge application with the Novu CLI.
</Card>
<Card icon={<LayoutDashboard />} href="/agents/custom-code-agent/setup-your-agent/overview" title="Set up overview">
<Card icon={<LayoutDashboard />} href="/connect/custom-code-agent/setup-your-agent/overview" title="Set up overview">
View dashboard settings, bridge URL, providers, and handler code.
</Card>
<Card icon={<Zap />} href="/agents/custom-code-agent/quickstart" title="Quickstart">
<Card icon={<Zap />} href="/connect/custom-code-agent/quickstart" title="Quickstart">
Create an agent, connect Slack, and get a reply in-thread.
</Card>
</Cards>
8 changes: 4 additions & 4 deletions ...t/setup-your-agent/edit-sent-messages.mdx → ...t/setup-your-agent/edit-sent-messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

`ctx.reply()` returns a `ReplyHandle` so that you can edit the message you just sent on the provider. This is useful when you post "Processing..." and replace it with the final text.

That is not a [reply type](/agents/custom-code-agent/setup-your-agent/reply); it updates a message you already sent.
That is not a [reply type](/connect/custom-code-agent/setup-your-agent/reply); it updates a message you already sent.

Check notice on line 12 in content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx#L12 

[Google.Contractions] Use 'that's' instead of 'That is'.
Raw output 
{"message": "[Google.Contractions] Use 'that's' instead of 'That is'.", "location": {"path": "content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx", "range": {"start": {"line": 12, "column": 1}}}, "severity": "INFO"}

Check notice on line 12 in content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx#L12 

[write-good.E-Prime] Try to avoid using 'is'.
Raw output 
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx", "range": {"start": {"line": 12, "column": 6}}}, "severity": "INFO"}

Check notice on line 12 in content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx#L12 

[Google.Semicolons] Use semicolons judiciously.
Raw output 
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "content/docs/connect/custom-code-agent/setup-your-agent/edit-sent-messages.mdx", "range": {"start": {"line": 12, "column": 78}}}, "severity": "INFO"}

## Basic edit

Expand All @@ -31,15 +31,15 @@
});
```

Edits update the existing platform message rather than posting a new one. Not every provider supports message editing. For which capabilities each provider supports, see [Agents and providers](/agents/get-started/agents-and-providers#provider-connections).
Edits update the existing platform message rather than posting a new one. Not every provider supports message editing. For which capabilities each provider supports, see [Agents and providers](/connect/get-started/agents-and-providers#provider-connections).

## Related

<Cards>
<Card icon={<LayoutGrid />} href="/agents/custom-code-agent/setup-your-agent/reply" title="Reply">
<Card icon={<LayoutGrid />} href="/connect/custom-code-agent/setup-your-agent/reply" title="Reply">
Send plain text, markdown, attachments, and interactive cards.
</Card>
<Card icon={<MousePointerClick />} href="/agents/custom-code-agent/setup-your-agent/handle-events" title="Handle events">
<Card icon={<MousePointerClick />} href="/connect/custom-code-agent/setup-your-agent/handle-events" title="Handle events">
Event handlers and the context object your agent receives on every turn.
</Card>
</Cards>
8 changes: 4 additions & 4 deletions ...-agent/setup-your-agent/handle-events.mdx → ...-agent/setup-your-agent/handle-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export const myAgent = agent('my-agent', {

### onAction

`onAction` fires when a user clicks a button or selects a value in an interactive card. See [Interactive cards](/agents/custom-code-agent/setup-your-agent/reply#interactive-cards).
`onAction` fires when a user clicks a button or selects a value in an interactive card. See [Interactive cards](/connect/custom-code-agent/setup-your-agent/reply#interactive-cards).

```typescript
import { agent } from '@novu/framework';
Expand Down Expand Up @@ -156,13 +156,13 @@ export const myAgent = agent('my-agent', {
## Related

<Cards>
<Card icon={<Reply />} href="/agents/custom-code-agent/setup-your-agent/reply" title="Reply">
<Card icon={<Reply />} href="/connect/custom-code-agent/setup-your-agent/reply" title="Reply">
Send plain text, markdown, attachments, and interactive cards.
</Card>
<Card icon={<Pencil />} href="/agents/custom-code-agent/setup-your-agent/edit-sent-messages" title="Edit sent messages">
<Card icon={<Pencil />} href="/connect/custom-code-agent/setup-your-agent/edit-sent-messages" title="Edit sent messages">
Update a message in place after sending it with `ReplyHandle`.
</Card>
<Card icon={<Brain />} href="/agents/custom-code-agent/build-your-first-agent" title="Build your first agent">
<Card icon={<Brain />} href="/connect/custom-code-agent/build-your-first-agent" title="Build your first agent">
Walk through a full support-bot handler file.
</Card>
</Cards>
0 ...tom-code-agent/setup-your-agent/meta.json → ...tom-code-agent/setup-your-agent/meta.json
View file
Open in desktop
File renamed without changes.
12 changes: 6 additions & 6 deletions ...-code-agent/setup-your-agent/overview.mdx → ...-code-agent/setup-your-agent/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,24 @@ A conversation starts when a user sends a message to your agent on a connected p
4. Your handler returns a reply and/or emits signals (metadata, trigger, resolve).
5. Novu delivers the reply to the provider thread and records activity in the dashboard.

For step-by-step inbound processing, see [Mental model](/agents/get-started/mental-model).
For step-by-step inbound processing, see [Mental model](/connect/get-started/mental-model).

## Where to go next

<Cards>
<Card icon={<Plus />} href="/agents/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
<Card icon={<Plus />} href="/connect/custom-code-agent/setup-your-agent/create-an-agent" title="Create an agent">
Create an agent in the Novu dashboard and connect a provider.
</Card>
<Card icon={<Brain />} href="/agents/custom-code-agent/setup-your-agent/scaffold-your-project" title="Scaffold your project">
<Card icon={<Brain />} href="/connect/custom-code-agent/setup-your-agent/scaffold-your-project" title="Scaffold your project">
Generate a bridge application with the Novu CLI.
</Card>
<Card icon={<Brain />} href="/agents/custom-code-agent/build-your-first-agent" title="Build your first agent">
<Card icon={<Brain />} href="/connect/custom-code-agent/build-your-first-agent" title="Build your first agent">
Build a support bot step by step.
</Card>
<Card icon={<MousePointerClick />} href="/agents/conversations" title="Conversation observability">
<Card icon={<MousePointerClick />} href="/connect/conversations" title="Conversation observability">
View conversations and activity in the dashboard.
</Card>
<Card icon={<Cloud />} href="/agents/custom-code-agent/going-to-production" title="Going to production">
<Card icon={<Cloud />} href="/connect/custom-code-agent/going-to-production" title="Going to production">
Run locally, deploy to development, and publish to production.
</Card>
</Cards>
Loading
Loading