Skip to content

A programming framework for agentic AI

Fix docs edit link and ref links (#448)

Jack Gerritsdf44d26c8708
diff --git a/python/packages/autogen-core/docs/src/conf.py b/python/packages/autogen-core/docs/src/conf.py
index 8d7f6a2ff..8cfe7353c 100644
--- a/python/packages/autogen-core/docs/src/conf.py
+++ b/python/packages/autogen-core/docs/src/conf.py
@@ -53,9 +53,9 @@ html_theme = "furo"
html_static_path = []
html_theme_options = {
- "source_repository": "https://github.com/microsoft/autogen_core",
+ "source_repository": "https://github.com/microsoft/agnext",
"source_branch": "main",
- "source_directory": "python/docs/src/",
+ "source_directory": "python/packages/autogen-core/docs/src/",
}
autodoc_default_options = {
diff --git a/python/packages/autogen-core/docs/src/getting-started/message-and-communication.ipynb b/python/packages/autogen-core/docs/src/getting-started/message-and-communication.ipynb
index ea266e9f8..d90835319 100644
--- a/python/packages/autogen-core/docs/src/getting-started/message-and-communication.ipynb
+++ b/python/packages/autogen-core/docs/src/getting-started/message-and-communication.ipynb
@@ -62,14 +62,14 @@
"### Message Handlers\n",
"\n",
"When an agent receives a message the runtime will invoke the agent's message handler\n",
- "({py:meth}`~agnext.base.Agent.on_message`) which should implement the agents message handling logic.\n",
+ "({py:meth}`~autogen_core.base.Agent.on_message`) which should implement the agents message handling logic.\n",
"If this message cannot be handled by the agent, the agent should raise a\n",
- "{py:class}`~agnext.base.exceptions.CantHandleException`.\n",
+ "{py:class}`~autogen_core.base.exceptions.CantHandleException`.\n",
"\n",
- "For convenience, the {py:class}`~agnext.components.RoutedAgent` base class\n",
- "provides the {py:meth}`~agnext.components.message_handler` decorator\n",
+ "For convenience, the {py:class}`~autogen_core.components.RoutedAgent` base class\n",
+ "provides the {py:meth}`~autogen_core.components.message_handler` decorator\n",
"for associating message types with message handlers,\n",
- "so developers do not need to implement the {py:meth}`~agnext.base.Agent.on_message` method.\n",
+ "so developers do not need to implement the {py:meth}`~autogen_core.base.Agent.on_message` method.\n",
"\n",
"For example, the following type-routed agent responds to `TextMessage` and `ImageMessage`\n",
"using different message handlers:"
@@ -166,8 +166,8 @@
"\n",
"Let's first look at direct messaging.\n",
"To send a direct message to another agent, within a message handler use\n",
- "the {py:meth}`agnext.base.BaseAgent.send_message` method,\n",
- "from the runtime use the {py:meth}`agnext.base.AgentRuntime.send_message` method.\n",
+ "the {py:meth}`autogen_core.base.BaseAgent.send_message` method,\n",
+ "from the runtime use the {py:meth}`autogen_core.base.AgentRuntime.send_message` method.\n",
"Awaiting calls to these methods will return the return value of the\n",
"receiving agent's message handler.\n",
"When the receiving agent's handler returns `None`, `None` will be returned.\n",
@@ -268,7 +268,7 @@
"recipient are tightly coupled -- they are created together and the sender\n",
"is linked to a specific instance of the recipient.\n",
"For example, an agent executes tool calls by sending direct messages to\n",
- "an instance of {py:class}`~agnext.components.tool_agent.ToolAgent`,\n",
+ "an instance of {py:class}`~autogen_core.components.tool_agent.ToolAgent`,\n",
"and uses the responses to form an action-observation loop."
]
},
@@ -299,8 +299,8 @@
"### Publishing to Topics\n",
"\n",
"To publish a message from an agent's handler,\n",
- "use the {py:meth}`agnext.base.BaseAgent.publish_message` method and specify\n",
- "a {py:class}`agnext.base.TopicId`.\n",
+ "use the {py:meth}`autogen_core.base.BaseAgent.publish_message` method and specify\n",
+ "a {py:class}`autogen_core.base.TopicId`.\n",
"This call must still be awaited to allow the runtime to schedule delivery of \n",
"the message to all subscribers,\n",
"but it will always return `None`.\n",
@@ -359,7 +359,7 @@
"Subscriptions are registered with the agent runtime, either as part of\n",
"agent type's registeration or through a separate API method.\n",
"\n",
- "Here is how we can register {py:class}`~agnext.components.TypeSubscription`\n",
+ "Here is how we can register {py:class}`~autogen_core.components.TypeSubscription`\n",
"for the broadcasting agent and receiving agent."
]
},
@@ -417,19 +417,19 @@
"### Default Topic and Subscriptions\n",
"\n",
"In the above example, we used\n",
- "{py:class}`~agnext.base.TopicId` and {py:class}`~agnext.components.TypeSubscription`\n",
+ "{py:class}`~autogen_core.base.TopicId` and {py:class}`~autogen_core.components.TypeSubscription`\n",
"to specify the topic and subscriptions respectively.\n",
"This is the appropriate way for many scenarios.\n",
"However, when there is a single scope of publishing, that is, \n",
"all agents publish and subscribe to all broadcasted messages,\n",
- "we can use the convenience classes {py:class}`~agnext.components.DefaultTopicId`\n",
- "and {py:class}`~agnext.components.DefaultSubscription` to simply our code.\n",
+ "we can use the convenience classes {py:class}`~autogen_core.components.DefaultTopicId`\n",
+ "and {py:class}`~autogen_core.components.DefaultSubscription` to simply our code.\n",
"\n",
- "{py:class}`~agnext.components.DefaultTopicId` is\n",
+ "{py:class}`~autogen_core.components.DefaultTopicId` is\n",
"for creating a topic that uses `\"default\"` as the default value for the topic type\n",
"and the publishing agent's key as the default value for the topic source.\n",
"We can simplify `BroadcastingAgent` by using \n",
- "{py:class}`~agnext.components.DefaultTopicId`."
+ "{py:class}`~autogen_core.components.DefaultTopicId`."
]
},
{
@@ -456,12 +456,12 @@
"metadata": {},
"source": [
"We can also simplify subscription using\n",
- "{py:class}`~agnext.components.DefaultSubscription`\n",
+ "{py:class}`~autogen_core.components.DefaultSubscription`\n",
"when registering it as part of agent type registration.\n",
"\n",
- "When the runtime calls {py:class}`~agnext.components.DefaultSubscription` in\n",
+ "When the runtime calls {py:class}`~autogen_core.components.DefaultSubscription` in\n",
"the context of the factory function, \n",
- "it creates a {py:class}`~agnext.components.TypeSubscription`\n",
+ "it creates a {py:class}`~autogen_core.components.TypeSubscription`\n",
"whose topic type uses `\"default\"` as the default value and \n",
"agent type uses the same agent type that is being registered in the same context."
]
@@ -500,8 +500,8 @@
"source": [
"```{note}\n",
"If your scenario allows all agents to publish and subscribe to\n",
- "all broadcasted messages, use {py:class}`~agnext.components.DefaultTopicId`\n",
- "and {py:class}`~agnext.components.DefaultSubscription` without setting its\n",
+ "all broadcasted messages, use {py:class}`~autogen_core.components.DefaultTopicId`\n",
+ "and {py:class}`~autogen_core.components.DefaultSubscription` without setting its\n",
"parameters.\n",
"```"
]
diff --git a/python/packages/autogen-core/docs/src/getting-started/quickstart.ipynb b/python/packages/autogen-core/docs/src/getting-started/quickstart.ipynb
index 301a5bc6a..1972ce068 100644
--- a/python/packages/autogen-core/docs/src/getting-started/quickstart.ipynb
+++ b/python/packages/autogen-core/docs/src/getting-started/quickstart.ipynb
@@ -94,7 +94,7 @@
"So the creation of agents are handled by the runtime.\n",
"\n",
"The following code shows how to register and run the agents using \n",
- "{py:class}`~agnext.application.SingleThreadedAgentRuntime`,\n",
+ "{py:class}`~autogen_core.application.SingleThreadedAgentRuntime`,\n",
"a local embedded agent runtime implementation.\n"
]
},