Skip to content

Commit c86e24e

Browse files
committed
updated docs
1 parent 14f3059 commit c86e24e

5 files changed

Lines changed: 751 additions & 26 deletions

File tree

agentex/docs/docs/development_guides/tutorials.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,43 @@
22

33
All hands-on tutorials are maintained in the Agentex Python repository.
44

5-
[Browse Tutorials on GitHub](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials){target="_blank"}
5+
[Browse Tutorials on GitHub](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials){target="_blank"}
66

77
## Available Tutorials
88

99
### Sync ACP (Simple Agents)
1010

1111
Basic agent patterns with simple request-response interactions.
1212

13-
- **[Hello ACP](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/00_sync/000_hello_acp){target="_blank"}**: Your first agent
14-
- **[Multiturn](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/00_sync/010_multiturn){target="_blank"}**: Conversation history and memory
15-
- **[Streaming](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/00_sync/020_streaming){target="_blank"}**: Real-time response streaming
13+
- **[Hello ACP](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/00_sync/000_hello_acp){target="_blank"}**: Your first agent
14+
- **[Multiturn](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/00_sync/010_multiturn){target="_blank"}**: Conversation history and memory
15+
- **[Streaming](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/00_sync/020_streaming){target="_blank"}**: Real-time response streaming
1616

1717
### Async ACP - Base (Learning & Development)
1818

1919
Stateful workflows with full lifecycle control for development and advanced patterns.
2020

21-
- **[Hello Async ACP](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/000_hello_acp){target="_blank"}**: Three-handler pattern fundamentals
22-
- **[Multiturn](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/010_multiturn){target="_blank"}**: Stateful conversations
23-
- **[Streaming](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/020_streaming){target="_blank"}**: Response streaming in complex workflows
24-
- **[Tracing](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/030_tracing){target="_blank"}**: Observability and debugging
25-
- **[Other SDKs](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/040_other_sdks){target="_blank"}**: OpenAI Agents SDK and MCP integration
26-
- **[Batch Events](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/080_batch_events){target="_blank"}**: Efficient multi-event handling
27-
- **[Multi-Agent Assembly Line](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/00_base/090_multi_agent_non_temporal){target="_blank"}**: Multi-agent coordination without Temporal
21+
- **[Hello Async ACP](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/000_hello_acp){target="_blank"}**: Three-handler pattern fundamentals
22+
- **[Multiturn](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/010_multiturn){target="_blank"}**: Stateful conversations
23+
- **[Streaming](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/020_streaming){target="_blank"}**: Response streaming in complex workflows
24+
- **[Tracing](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/030_tracing){target="_blank"}**: Observability and debugging
25+
- **[Other SDKs](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/040_other_sdks){target="_blank"}**: OpenAI Agents SDK and MCP integration
26+
- **[Batch Events](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/080_batch_events){target="_blank"}**: Efficient multi-event handling
27+
- **[Multi-Agent Assembly Line](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/00_base/090_multi_agent_non_temporal){target="_blank"}**: Multi-agent coordination without Temporal
2828

2929
### Async ACP - Temporal (Production)
3030

3131
Enterprise-ready patterns with durable execution for production deployments requiring reliability and fault tolerance.
3232

33-
- **[Hello Temporal](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/000_hello_acp){target="_blank"}**: First Temporal workflow
34-
- **[Agent Chat](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/010_agent_chat){target="_blank"}**: LLM chat with tools integration
35-
- **[State Machine](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/020_state_machine){target="_blank"}**: Complex workflow orchestration
36-
- **[Custom Activities](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/030_custom_activities){target="_blank"}**: Custom activities for external operations
37-
- **[Agent Chat with Guardrails](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/050_agent_chat_guardrails){target="_blank"}**: Safety and validation for agent conversations
38-
- **[OpenAI Agents SDK Integration](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/){target="_blank"}**: Production-ready agents with OpenAI SDK + Temporal
39-
- [OpenAI Agents SDK: Hello World](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/060_open_ai_agents_sdk_hello_world){target="_blank"}: Automatic durability for LLM calls
40-
- [OpenAI Agents SDK: Tools](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/070_open_ai_agents_sdk_tools){target="_blank"}: Single and multi-activity tool patterns
41-
- [OpenAI Agents SDK: Human-in-the-Loop](https://github.com/scaleapi/agentex-python/tree/main/examples/tutorials/10_async/10_temporal/080_open_ai_agents_sdk_human_in_the_loop){target="_blank"}: Human approval workflows
33+
- **[Hello Temporal](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/000_hello_acp){target="_blank"}**: First Temporal workflow
34+
- **[Agent Chat](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/010_agent_chat){target="_blank"}**: LLM chat with tools integration
35+
- **[State Machine](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/020_state_machine){target="_blank"}**: Complex workflow orchestration
36+
- **[Custom Activities](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/030_custom_activities){target="_blank"}**: Custom activities for external operations
37+
- **[Agent Chat with Guardrails](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/050_agent_chat_guardrails){target="_blank"}**: Safety and validation for agent conversations
38+
- **[OpenAI Agents SDK Integration](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/){target="_blank"}**: Production-ready agents with OpenAI SDK + Temporal
39+
- [OpenAI Agents SDK: Hello World](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/060_open_ai_agents_sdk_hello_world){target="_blank"}: Automatic durability for LLM calls
40+
- [OpenAI Agents SDK: Tools](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/070_open_ai_agents_sdk_tools){target="_blank"}: Single and multi-activity tool patterns
41+
- [OpenAI Agents SDK: Human-in-the-Loop](https://github.com/scaleapi/scale-agentex-python/tree/main/examples/tutorials/10_async/10_temporal/080_open_ai_agents_sdk_human_in_the_loop){target="_blank"}: Human approval workflows
4242

4343
## Why Tutorials are on GitHub
4444

agentex/docs/docs/development_guides/webhooks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,24 +108,24 @@ You will not be able to retrieve the API key value after you've created the API
108108

109109
To store a GitHub secret that will be used to verify incoming webhook requests, grab the full name of the repository you will be configuring the webhook for and run the following command:
110110
```bash
111-
# Replace with your repository name instead of scaleapi/agentex!
111+
# Replace with your repository name instead of scaleapi/scale-agentex!
112112
curl -X POST $HOST/agent_api_keys \
113113
-H "Content-Type: application/json" \
114114
-d '{
115115
"agent_name": "<AGENT_NAME>",
116-
"name": "scaleapi/agentex",
116+
"name": "scaleapi/scale-agentex",
117117
"api_key_type": "github"
118118
}'
119119
```
120120
The backend will generate an API key value for you, store this in the database, and return the value for you in the response so that you can set it in GitHub as the webhook secret.
121121
If you already have a webhook configured with a secret and you don't want to rotate it, you can also pass it as follows:
122122
```bash
123-
# Replace with your repository name instead of scaleapi/agentex
123+
# Replace with your repository name instead of scaleapi/scale-agentex
124124
curl -X POST $HOST/agent_api_keys \
125125
-H "Content-Type: application/json" \
126126
-d '{
127127
"agent_name": "<AGENT_NAME>",
128-
"name": "scaleapi/agentex",
128+
"name": "scaleapi/scale-agentex",
129129
"api_key_type": "github",
130130
"api_key": "existingsecret"
131131
}'

0 commit comments

Comments
 (0)