Skip to content

Commit 769069a

Browse files
authored
Standardize the nav bar (#359)
- Use index.md files where a section has an overview - Except for section-headers, as that just looks weird - Also reformatted some code blocks for syntax highlighting --------- Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
1 parent 2fa4caf commit 769069a

File tree

19 files changed

+119
-114
lines changed

19 files changed

+119
-114
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,13 +193,13 @@ The goal of this repository is to revamp this documentation repo so that it prov
193193
│ │ ├── streaming
194194
│ │ │ ├── async-iterators.md
195195
│ │ │ ├── callback-handlers.md
196-
│ │ │ └── overview.md
196+
│ │ │ └── index.md
197197
│ │ └── tools
198198
│ │ ├── community-tools-package.md
199199
│ │ ├── executors.md
200200
│ │ ├── mcp-tools.md
201201
│ │ ├── python-tools.md
202-
│ │ └── tools_overview.md
202+
│ │ └── index.md
203203
│ ├── deploy
204204
│ │ ├── deploy_to_amazon_ec2.md
205205
│ │ ├── deploy_to_amazon_eks.md

docs/user-guide/concepts/agents/agent-loop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Solutions:
110110

111111
### Inappropriate Tool Selection
112112

113-
When the model consistently picks the wrong tool, the problem is usually ambiguous tool descriptions. Review the descriptions from the model's perspective. If two tools have overlapping descriptions, the model has no basis for choosing between them. See [Tools Overview](../tools/tools_overview.md) for guidance on writing effective descriptions.
113+
When the model consistently picks the wrong tool, the problem is usually ambiguous tool descriptions. Review the descriptions from the model's perspective. If two tools have overlapping descriptions, the model has no basis for choosing between them. See [Tools Overview](../tools/index.md) for guidance on writing effective descriptions.
114114

115115
### MaxTokensReachedException
116116

docs/user-guide/concepts/experimental/bidirectional-streaming/agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ See [Model Providers](models/nova_sonic.md) for provider-specific options.
233233

234234
`BidiAgent` supports many of the same constructs as `Agent`:
235235

236-
- **[Tools](../../tools/tools_overview.md)**: Function calling works identically
236+
- **[Tools](../../tools/index.md)**: Function calling works identically
237237
- **[Hooks](hooks.md)**: Lifecycle event handling with bidirectional-specific events
238238
- **[Session Management](session-management.md)**: Conversation persistence across sessions
239239
- **[Tool Executors](../../tools/executors.md)**: Concurrent and custom execution patterns

docs/user-guide/concepts/experimental/bidirectional-streaming/events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Bidirectional streaming events enable real-time monitoring and processing of aud
66

77
## Event Model
88

9-
Bidirectional streaming uses a different event model than [standard streaming](../../streaming/overview.md):
9+
Bidirectional streaming uses a different event model than [standard streaming](../../streaming/index.md):
1010

1111
**Standard Streaming:**
1212

@@ -322,7 +322,7 @@ Events for tool execution during conversations. Bidirectional streaming reuses t
322322

323323
#### ToolUseStreamEvent
324324

325-
Emitted when the model requests tool execution. See [Tools Overview](../../tools/tools_overview.md) for details.
325+
Emitted when the model requests tool execution. See [Tools Overview](../../tools/index.md) for details.
326326

327327
```python
328328
{

docs/user-guide/concepts/interrupts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ agent = Agent(
156156

157157
```
158158

159-
> ⚠️ Interrupts are not supported in [direct tool calls](./tools/tools_overview.md#direct-method-calls) (i.e., calls such as `agent.tool.my_tool()`).
159+
> ⚠️ Interrupts are not supported in [direct tool calls](./tools/index.md#direct-method-calls) (i.e., calls such as `agent.tool.my_tool()`).
160160
161161
### Components
162162

docs/user-guide/concepts/multi-agent/graph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ async for event in graph.stream_async("Research and analyze market trends"):
334334
print(f"Graph completed: {result.status}")
335335
```
336336

337-
See the [streaming overview](../streaming/overview.md#multi-agent-events) for details on all multi-agent event types.
337+
See the [streaming overview](../streaming/index.md#multi-agent-events) for details on all multi-agent event types.
338338

339339
## Graph Results
340340

docs/user-guide/concepts/multi-agent/swarm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ async for event in swarm.stream_async("Design and implement a REST API"):
225225
print(f"\nSwarm completed: {result.status}")
226226
```
227227

228-
See the [streaming overview](../streaming/overview.md#multi-agent-events) for details on all multi-agent event types.
228+
See the [streaming overview](../streaming/index.md#multi-agent-events) for details on all multi-agent event types.
229229

230230
## Swarm Results
231231

docs/user-guide/concepts/streaming/async-iterators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Async iterators provide asynchronous streaming of agent events, allowing you to process events as they occur in real-time. This approach is ideal for asynchronous frameworks where you need fine-grained control over async execution flow.
44

5-
For a complete list of available events including text generation, tool usage, lifecycle, and reasoning events, see the [streaming overview](./overview.md#event-types).
5+
For a complete list of available events including text generation, tool usage, lifecycle, and reasoning events, see the [streaming overview](./index.md#event-types).
66

77
## Basic Usage
88

docs/user-guide/concepts/streaming/callback-handlers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Callback handlers allow you to intercept and process events as they happen during agent execution in Python. This enables real-time monitoring, custom output formatting, and integration with external systems through function-based event handling.
66

7-
For a complete list of available events including text generation, tool usage, lifecycle, and reasoning events, see the [streaming overview](./overview.md#event-types).
7+
For a complete list of available events including text generation, tool usage, lifecycle, and reasoning events, see the [streaming overview](./index.md#event-types).
88

99
> **Note:** For asynchronous applications, consider [async iterators](./async-iterators.md) instead.
1010
File renamed without changes.

0 commit comments

Comments
 (0)