Skip to content

Commit c962f0a

Browse files
committed
docs: Update agent documentation with comprehensive improvements
- Consolidated and streamlined agent documentation content - Removed redundant files (best-practices.mdx, why-agents.mdx) and integrated content into other files - Enhanced building-quality-agents.mdx with improved guidance and best practices - Updated getting-featured.mdx with clearer instructions and better structure - Improved chat-agents.mdx with better content organization - Fixed sidebar navigation in docs.json to remove references to deleted files - Set clearer expectations for agent developers by framing process as getting feedback This consolidates all changes from PR #398 into a single comprehensive commit.
1 parent 7f9c0c5 commit c962f0a

File tree

6 files changed

+26
-65
lines changed

6 files changed

+26
-65
lines changed

docs/base-app/agents/best-practices.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/base-app/agents/building-quality-agents.mdx

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: 'Building Quality Agents for Base App'
3-
description: Learn the best practices and guidelines for creating high-quality agents that get featured in Base App
4-
sidebarTitle: 'Building Quality Agents'
2+
title: 'UX Guidelines'
3+
description: Learn the best practices and guidelines for building quality agents
4+
sidebarTitle: 'UX Guidelines'
55
---
66

7-
As you start building, review these guidelines to understand what we look for when featuring agents in the Base app. We recommend trying out existing agents in the app first to get a feel for the quality bar, what works well, and areas for improvement.
7+
As you start building, review these guidelines to understand what makes an agent successful in the Base app. We recommend trying out existing agents in the app first to get a feel for the quality bar, what works well, and areas for improvement.
88

99
## Build a high quality foundation
1010

1111
Your agent should provide a seamless, professional experience that users will want to engage with repeatedly. Here are the core requirements:
1212

13-
### Response Behavior
13+
### Responding to messages
1414

1515
**Multi-Channel Support**
1616
- Respond to both DMs and group chats appropriately
@@ -53,7 +53,7 @@ Your agent's first impression is critical. The onboarding message should immedia
5353

5454
1. **Introduce the agent** - Quick, friendly greeting with the agent's name
5555
2. **Explain capabilities** - Clear, specific examples of what it can do
56-
3. **Provide next steps** - Give users an obvious action to take
56+
4. **Use quick select buttons** - Make it easy for users to select an action to take with the agent
5757

5858
### Example: High-Quality Onboarding
5959

@@ -106,7 +106,7 @@ Focus on helping users:
106106
### Design for Engagement
107107

108108
**Build Natural Growth Loops**
109-
- Include features that encourage sharing and re-engagement
109+
- Include features that encourage sharing, re-engagement, and habit forming
110110
- Make it beneficial for users to invite others
111111
- Create ongoing value that brings users back
112112

@@ -132,15 +132,4 @@ As users complete actions with your agent:
132132
- **Recurring value** - Automated tasks, alerts, or regular check-ins
133133
- **Gamification** - Points, levels, or achievement systems
134134

135-
## Next steps
136135

137-
Once you've built your agent following these guidelines:
138-
139-
1. **Test thoroughly** - Try your agent in different scenarios and conversation types
140-
2. **Get feedback** - Have others test and provide honest feedback
141-
3. **Iterate quickly** - Make improvements based on real user interactions
142-
4. **Submit for review** - Follow the submission guidelines when ready
143-
144-
Remember: agents often go through multiple rounds of feedback before being featured. Focus on creating genuine value and a polished user experience that people will love using repeatedly.
145-
146-
For technical implementation details, see our [Chat Agents guide](/base-app/agents/chat-agents).

docs/base-app/agents/chat-agents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Chat Agents in Base App'
33
description: Learn how to build chat agents for Base App, using XMTP
4-
sidebarTitle: 'Chat Agents'
4+
sidebarTitle: 'Overview'
55
---
66

77
This guide will cover how you can get started building messaging agents for Base App, using XMTP, a decentralized messaging protocol. Discover a fast, easy way to build and get distribution in Base App.

docs/base-app/agents/getting-featured.mdx

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
title: 'Getting Your Agent Featured'
3-
description: 'Learn how to submit your chat agent for review and get featured in Base App'
4-
sidebarTitle: 'Getting Featured'
2+
title: 'Get Feedback on Your Agent'
3+
description: 'Learn how to submit your chat agent for feedback from the Base and XMTP teams'
4+
sidebarTitle: 'Get Feedback'
55
---
66

7-
## Getting featured
7+
## Launch Check-list
8+
9+
Review this checklist before submitting your agent for feedback.
10+
11+
* ✔ Agent has a Basename (.base.eth)
12+
* ✔ Agent reacts to messages with 👀 emoji
13+
* ✔ Agent has a clear onboarding message that introduces itself, its capabilities, and gives the user a clear next step to take.
14+
* ✔ Agent utilizes quick select buttons when necessary to make actions easier on the user.
15+
* ✔ Agent solves a clear problem and provides value to users.
16+
17+
Fill out [this form](https://app.deform.cc/form/52b71db4-bfa2-4ef5-a954-76c66250bdd2) to submit your agent for feedback. You will hear back from us within **5 business days**, and someone from the **Base** or **XMTP** team will contact you through DM on the Base app. Make sure to check your requests!
18+
19+
We recommend posting a demo of your agent on the **Base app social feed** to get feedback from the community.
20+
21+
822

9-
Fill out the form [here](https://app.deform.cc/form/52b71db4-bfa2-4ef5-a954-76c66250bdd2/?page_number=0) to submit your agent for review. Note, agents often go through multiple rounds of feedback before they are ready to be featured. Once approved, your agent will be featured in Base App. You will hear back from us within 5 business days.
1023

11-
Need help or have feature requests? Visit [https://community.xmtp.org/](https://community.xmtp.org/)

docs/base-app/agents/why-agents.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/docs.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,6 @@
400400
{
401401
"group": "Chat Agents",
402402
"pages": [
403-
"base-app/agents/why-agents",
404403
"base-app/agents/chat-agents",
405404
"base-app/agents/building-quality-agents",
406405
"base-app/agents/getting-started",
@@ -409,7 +408,6 @@
409408
"base-app/agents/deeplinks",
410409
"base-app/agents/x402-agents",
411410
"base-app/agents/mini-apps-and-agents",
412-
"base-app/agents/best-practices",
413411
"base-app/agents/getting-featured"
414412
]
415413
}

0 commit comments

Comments
 (0)