docs(update): Enhance Agents content with updated quickstart, concepts, instructions, and tools #539
Conversation
✅ Deploy Preview for luxury-shortbread-acee05 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Recaptured screenshots with a new tool because Snagit is too blurry.
cjcenizal
left a comment
cjcenizal
left a comment
There was a problem hiding this comment.
I'm pausing my review because I see pages in the diff that I can't find in the navigation. Can you show me where these are being surfaced?
| @@ -0,0 +1,137 @@ | |||
| --- | |||
| id: create-agent-examples | |||
There was a problem hiding this comment.
Where is this page found in the side bar? I don't see it.
There was a problem hiding this comment.
This was moved to the API Reference under Agents, Examples. There's only one example in their for now (I plan on adding more this quarter).
| @@ -0,0 +1,101 @@ | |||
| --- | |||
| id: custom-tools | |||
There was a problem hiding this comment.
This was removed from the sidebar by mistake and will be re-added!
Screenshots were blurry when I captured and resized them, so now I resize them within the markdown topics.
cjcenizal
left a comment
cjcenizal
left a comment
There was a problem hiding this comment.
🔥 This is awesome! Nice work striking the right balance of information throughout the various pages. I appreciated the cross-links from the long-form content to the new examples in the API references. Loved the attention to detail in the various walk-throughs. The content emphasizes technical details, while explaining them in an approachable way, with no fluff.
www/docs/agents/agents-quickstart.md
Outdated
| 1. The **Preview** tab opens and you can now chat with your agent. | ||
| 2. (Optional) To update the agent's configuration from the previous steps, click the **Settings** tab. | ||
| 3. Let's test the agent by asking questions about the data. | ||
|  |
There was a problem hiding this comment.
This screenshot of the demo agent feels incongruous since this quick start doesn't involve creating a demo agent. I suggest removing the screenshot, or cutting out the chat portion if you want to focus on the "Settings" tab.
www/docs/agents/agents-quickstart.md
Outdated
|
|
||
| 1. The **Preview** tab opens and you can now chat with your agent. | ||
| 2. (Optional) To update the agent's configuration from the previous steps, click the **Settings** tab. | ||
| 3. Let's test the agent by asking questions about the data. |
There was a problem hiding this comment.
Nit: I think we should leave out "Let's" since the framing throughout this doc has been about the reader ("you"), not "us".
Also, we should expand on this and be more specific. The agent uses the web search tool, so we should set expectations for the user, for example:
Because you configured the agent with the web_search tool, it will be able to retrieve information from the web to answer your question. For example, try asking, "What's the weather like in Tokyo today?"
www/docs/agents/subagents.md
Outdated
| import CodePanel from '@site/src/theme/CodePanel'; | ||
|
|
||
| The sub-agent tool enables your agent to delegate specialized tasks to other | ||
| The sub-agent tool enables your agent to delegate specialized tasks to existing |
There was a problem hiding this comment.
This file looks very similar to subagent-tool.md. Are they both being used? I could only find one page on sub-agents in the nav.
pwoznic
changed the title
2 participants
Fixes #534
Improved quickstart, concepts, instructions, and tools subsections