Skip to content

A programming framework for agentic AI

small doc fixes (#103)

Eric Zhuef12ca4b4ebe
diff --git a/python/docs/src/index.rst b/python/docs/src/index.rst
index 73c142589..16922a9a6 100644
--- a/python/docs/src/index.rst
+++ b/python/docs/src/index.rst
@@ -13,15 +13,10 @@ common uses, such as chat completion agents, but also allows for fully custom ag
AGNext's developer API consists of the following layers:
-- :doc:`core <reference/agnext.core>` - The core interfaces that defines agent
- and runtime.
-- :doc:`application <reference/agnext.application>` - Implementations of the runtime
- and other modules (e.g., logging) for building applications.
-- :doc:`components <reference/agnext.components>` - Interfaces and implementations
- for agents, models, memory, and tools.
-- :doc:`chat <reference/agnext.chat>` - High-level API for creating demos and
- experimenting with multi-agent patterns. It offers pre-built agents, patterns,
- message types, and memory stores.
+- :doc:`core <reference/agnext.core>` - The core interfaces that defines agent and runtime.
+- :doc:`application <reference/agnext.application>` - Implementations of the runtime and other modules (e.g., logging) for building applications.
+- :doc:`components <reference/agnext.components>` - Interfaces and implementations for agents, models, memory, and tools.
+- :doc:`chat <reference/agnext.chat>` - High-level API for creating demos and experimenting with multi-agent patterns. It offers pre-built agents, patterns, message types, and memory stores.
diff --git a/python/examples/README.md b/python/examples/README.md
index 322f171ce..fbe3a3582 100644
--- a/python/examples/README.md
+++ b/python/examples/README.md
@@ -2,23 +2,38 @@
This directory contains examples of how to use AGNext.
+## `chat` layer examples
+
We provide examples that use pre-built agents and message types in the `chat` layer.
These examples are intended for users who want to quickly create
demos and experimenting with multi-agent design paterns.
+### Single agent examples
+
+- `assistant.py`: a demonstration of how to use the OpenAI Assistant API to create
+ a ChatGPT agent.
+
+### Reflection pattern examples
+
- `coder_reviewer.py`: using a coder and reviewer agents to implement the
reflection pattern for code generation.
- `illustrator_critics.py`: using an illustrator, critics and descriptor agent
to implement the reflection pattern for image generation.
- `chest_game.py`: using two chess player agents to demonstrate tool use and reflection
on tool use.
-- `assistant.py`: a demonstration of how to use the OpenAI Assistant API to create
- a ChatGPT agent.
+
+### Group chat pattern examples
+
- `software_consultancy.py`: a demonstration of multi-agent interaction using
the group chat pattern.
+
+### Orchestrator pattern examples
+
- `orchestrator.py`: a demonstration of multi-agent problem solving using
the orchestrator pattern.
+## Advanced examples
+
We also provide examples that use only the `core`, `application`, and `components` layers.
These examples are intended for advanced users who want to create
custom agents and message types for building applications.