Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion content/docs/agents/get-started/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@

Here's what happens at each step:

![architecture](/images/agents/concept/mental-model.png)


### Receive and identify

Novu receives the platform webhook and normalizes it into a standard format. It matches the platform user, for example, a Slack user ID to a Novu subscriber. Known users get their full profile attached, while unknown users are tracked as anonymous until identity is resolved.
Novu receives the platform webhook and normalizes it into a standard format. It matches the platform user, for example, a Slack user ID to a Novu subscriber. Known users get their full profile attached, while Novu tracks unknown users as anonymous until their identity is resolved.

Check notice on line 26 in content/docs/agents/get-started/core-concepts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/agents/get-started/core-concepts.mdx#L26

[Google.Passive] In general, use active voice instead of passive voice ('is resolved').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is resolved').", "location": {"path": "content/docs/agents/get-started/core-concepts.mdx", "range": {"start": {"line": 26, "column": 270}}}, "severity": "INFO"}

Check warning on line 26 in content/docs/agents/get-started/core-concepts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/agents/get-started/core-concepts.mdx#L26

[write-good.Passive] 'is resolved' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is resolved' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/agents/get-started/core-concepts.mdx", "range": {"start": {"line": 26, "column": 270}}}, "severity": "WARNING"}

Check notice on line 26 in content/docs/agents/get-started/core-concepts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/agents/get-started/core-concepts.mdx#L26

[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/agents/get-started/core-concepts.mdx", "range": {"start": {"line": 26, "column": 270}}}, "severity": "INFO"}

### Load conversation

Expand Down
23 changes: 10 additions & 13 deletions content/docs/agents/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Quickstart"
pageTitle: 'Novu Agents Quickstart'
pageTitle: 'Get started with Novu for Agents'
description: 'Create your first agent and connect it to Slack in under 10 minutes.'
icon: Zap
---
Expand All @@ -11,23 +11,19 @@

By the end, you'll have a working agent that receives messages from Slack and replies based on its configuration in your code.

## Prerequisites:
**Prerequisites:**

To get the most out of this guide, you’ll need to:

* A [Novu account](https://dashboard.novu.co).
* A Slack workspace where you have permission to install apps.
* Node.js installed on your machine.


## Steps to create your first agent
THese steps will guide you through the process of creating your first agent and connecting it to Slack.

<Steps>

<Step>

### Create your agent
## Create your agent

1. Go to the Novu dashboard.
2. In the sidebar, click **Agents**.
Expand All @@ -46,7 +42,7 @@

<Step>

### Select a provider
## Select a provider

1. In the setup page, open the **Select provider** dropdown.
2. Select **Slack**.
Expand All @@ -59,7 +55,7 @@

<Step>

### Create a Slack app
## Create a Slack app

Check warning on line 58 in content/docs/agents/get-started/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] content/docs/agents/get-started/quickstart.mdx#L58

[Google.Headings] 'Create a Slack app' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Create a Slack app' should use sentence-style capitalization.", "location": {"path": "content/docs/agents/get-started/quickstart.mdx", "range": {"start": {"line": 58, "column": 4}}}, "severity": "WARNING"}

Novu can create the Slack app for you automatically using a Slack App Configuration Token. You'll generate the token once, paste it into Novu, and Novu handles the rest.

Expand All @@ -79,7 +75,7 @@

<Step>

### Install the app in your workspace
## Install the app in your workspace

After Novu creates the Slack app, install it to your workspace. This is the same flow your end users will follow when they install the agent.

Expand All @@ -97,7 +93,7 @@

<Step>

### Scaffold your agent project
## Scaffold your agent project

With the provider connected, the dashboard shows the next phase: connecting your code. Novu provides a pre-filled CLI command that creates a starter project with your agent identifier and secret key already configured.

Expand All @@ -118,7 +114,7 @@

<Step>

### Start your agent locally
## Start your agent locally

Run the dev command below in your project directory. This starts your app, opens a dev tunnel, and registers the bridge URL with Novu so messages can reach your local handler.

Expand All @@ -131,7 +127,7 @@
</Step>

<Step>
### Send a message
## Send a message

Open the Slack channel where your app is installed and send a message to your bot. Your `onMessage` handler fires, and the reply appears in the thread.

Expand All @@ -140,6 +136,7 @@
Edit the files in `app/novu/agents/` to customize how your agent responds. See [Handle Events](/agents/setup-your-agent/connect-your-code/handle-events) for the full list of events your agent can respond to.
</Step>
</Steps>

## Next steps

You have a working agent connected to Slack. Here's where to go from here:
Expand Down
2 changes: 2 additions & 0 deletions content/docs/agents/get-started/what-is-aci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ You build your agent once. ACI handles delivery everywhere. The goal isn't only

ACI introduces a three-part architecture that separates platform delivery from agent intelligence.

![architecture](/images/agents/concept/architecture.png)

### Communication channels

Communication channels are the places where users interact with the agent, such as Slack, Microsoft Teams, WhatsApp, Telegram, and more. When a user sends a message on any of these platforms, it enters the ACI layer.
Expand Down
Binary file added public/images/agents/concept/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/agents/concept/diagram.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/agents/concept/mental-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading