diff --git a/docs/dotnet/README.md b/docs/dotnet/README.md index fd587ad2807d..45fe4e30fcd8 100644 --- a/docs/dotnet/README.md +++ b/docs/dotnet/README.md @@ -1,13 +1,16 @@ -## How to build and run the website +# How to build and run the website -### Prerequisites -- dotnet 7.0 or later +## Prerequisites + +- dotnet 8.0 or later + +## Build -### Build Firstly, go to autogen/dotnet folder and run the following command to build the website: + ```bash dotnet tool restore -dotnet tool run docfx website/docfx.json --serve +dotnet tool run docfx ../docs/dotnet/docfx.json --serve ``` -After the command is executed, you can open your browser and navigate to `http://localhost:8080` to view the website. \ No newline at end of file +After the command is executed, you can open your browser and navigate to `http://localhost:8080` to view the website. diff --git a/docs/dotnet/docfx.json b/docs/dotnet/docfx.json index 7eefe1a32b1a..f43779dd3e85 100644 --- a/docs/dotnet/docfx.json +++ b/docs/dotnet/docfx.json @@ -5,7 +5,11 @@ { "files": [ "src/Microsoft.AutoGen/Core/**/*.csproj", - "src/Microsoft.AutoGen/Contracts/**/*.csproj" + "src/Microsoft.AutoGen/Contracts/**/*.csproj", + "src/Microsoft.AutoGen/Core.Grpc/**/*.csproj", + "src/Microsoft.AutoGen/AgentHost/**/*.csproj", + "src/Microsoft.AutoGen/RuntimeGateway.Grpc/**/*.csproj", + "src/Microsoft.AutoGen/Extensions/**/*.csproj" ], "src": "../../dotnet/" } diff --git a/docs/dotnet/index.md b/docs/dotnet/index.md index e5c206c9a766..dc6dac9ece82 100644 --- a/docs/dotnet/index.md +++ b/docs/dotnet/index.md @@ -1,15 +1,6 @@ --- _disableAffix: true --- -
+ +[](https://github.com/microsoft/autogen/actions/workflows/dotnet-build.yml) +[](https://badge.fury.io/nu/Microsoft.AutoGen.Contracts) +[](https://badge.fury.io/nu/Microsoft.AutoGen.Core) +[](https://badge.fury.io/nu/Microsoft.AutoGen.Core.Grpc) +[](https://badge.fury.io/nu/Microsoft.AutoGen.RuntimeGateway.Grpc) +[](https://badge.fury.io/nu/Microsoft.AutoGen.AgentHost) + +
An event-driven programming framework for building scalable multi-agent AI systems.
+ +- Deterministic and dynamic agentic workflows for business processes +- Research on multi-agent collaboration +- Distributed agents for multi-language applications +- integration with event-driven, cloud native applications + +*Start here if you are building workflows or distributed agent systems* + ++
+
+```bash
+dotnet add package Microsoft.AutoGen.Contracts
+dotnet add package Microsoft.AutoGen.Core
+
+# optionally - for distributed agent systems:
+dotnet add package Microsoft.AutoGen.RuntimeGateway.Grpc
+dotnet add package Microsoft.AutoGen.AgentHost
+
+# other optional packages
+dotnet add package Microsoft.AutoGen.Agents
+dotnet add package Microsoft.AutoGen.Extensions.Aspire
+dotnet add package Microsoft.AutoGen.Extensions.MEAI
+dotnet add package Microsoft.AutoGen.Extensions.SemanticKernel
+```
+
+