Skip to content

A programming framework for agentic AI

Fix docs typos. (#5975)

湛露先生20753ad38cde
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c2e781239..ba1168b60 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ For common tasks that are helpful during development and run in CI, see [here](.
## Roadmap
-We use GitHub issues and milestones to track our roadmap. You can view the upcoming milestones [here]([Roadmap Issues](https://aka.ms/autogen-roadmap).
+We use GitHub issues and milestones to track our roadmap. You can view the upcoming milestones [here]([Roadmap Issues](https://aka.ms/autogen-roadmap)).
## Versioning
@@ -48,11 +48,11 @@ We will update verion numbers according to the following rules:
## Release process
1. Create a PR that updates the version numbers across the codebase ([example](https://github.com/microsoft/autogen/pull/4359))
- 2. The docs CI will fail for the PR, but this is expected and will be resolved in the next step
-2. After merging the PR, create and push a tag that corresponds to the new verion. For example, for `0.4.0.dev13`:
+2. The docs CI will fail for the PR, but this is expected and will be resolved in the next step
+3. After merging the PR, create and push a tag that corresponds to the new verion. For example, for `0.4.0.dev13`:
- `git tag v0.4.0.dev13 && git push origin v0.4.0.dev13`
-3. Restart the docs CI by finding the failed [job corresponding to the `push` event](https://github.com/microsoft/autogen/actions/workflows/docs.yml) and restarting all jobs
-4. Run [this](https://github.com/microsoft/autogen/actions/workflows/single-python-package.yml) workflow for each of the packages that need to be released and get an approval for the release for it to run
+4. Restart the docs CI by finding the failed [job corresponding to the `push` event](https://github.com/microsoft/autogen/actions/workflows/docs.yml) and restarting all jobs
+5. Run [this](https://github.com/microsoft/autogen/actions/workflows/single-python-package.yml) workflow for each of the packages that need to be released and get an approval for the release for it to run
## Triage process
diff --git a/docs/design/01 - Programming Model.md b/docs/design/01 - Programming Model.md
index 6bfa9f976..297051944 100644
--- a/docs/design/01 - Programming Model.md
+++ b/docs/design/01 - Programming Model.md
@@ -11,7 +11,7 @@ Each event in the system is defined using the [CloudEvents Specification](https:
1. *id* - A unique id (eg. a UUID).
2. *source* - A URI or URN indicating the event's origin.
3. *type* - The namespace of the event - prefixed with a reverse-DNS name.
- - The prefixed domain dictates the organization which defines the semantics of this event type: e.g `com.github.pull_request.opened` or `com.example.object.deleted.v2`), and optionally fields describing the data schema/content-type or extensions.
+ - The prefixed domain dictates the organization which defines the semantics of this event type: e.g (`com.github.pull_request.opened` or `com.example.object.deleted.v2`), and optionally fields describing the data schema/content-type or extensions.
## Event Handlers
diff --git a/docs/design/02 - Topics.md b/docs/design/02 - Topics.md
index d7c93417c..008e1aa9b 100644
--- a/docs/design/02 - Topics.md
+++ b/docs/design/02 - Topics.md
@@ -62,7 +62,7 @@ For this subscription source should map directly to agent key.
This subscription will therefore receive all events for the following well known topics:
-- `{AgentType}:` - General purpose direct messages. These should be routed to the approriate message handler.
-- `{AgentType}:rpc_request={RequesterAgentType}` - RPC request messages. These should be routed to the approriate RPC handler, and RequesterAgentType used to publish the response
+- `{AgentType}:` - General purpose direct messages. These should be routed to the appropriate message handler.
+- `{AgentType}:rpc_request={RequesterAgentType}` - RPC request messages. These should be routed to the appropriate RPC handler, and RequesterAgentType used to publish the response
- `{AgentType}:rpc_response={RequestId}` - RPC response messages. These should be routed back to the response future of the caller.
- `{AgentType}:error={RequestId}` - Error message that corresponds to the given request.