Minor updates after the v.0.0.0 release (#157)

* wip

* spelling fixed

* fix links

* fix test

* Fix typo

---------

Co-authored-by: Kumaran Rajendhiran <kumaran@airt.ai>

.github/workflows/update-release-notes.yaml

@@ -55,7 +55,7 @@ jobs:
 
       - name: Create Pull Request
         if: steps.git-check.outputs.changes_detected
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
           branch: ${{ env.BRANCH_NAME }}
@@ -64,4 +64,4 @@ jobs:
           commit-message: "Update Release Notes for ${{ env.TAG_NAME }}"
           body: "This is an automated pull request to update the release notes for ${{ env.TAG_NAME }}"
           labels: documentation
-          reviewers: davorrunje, Lancetnik, kumaranvpl, sternakt
+          reviewers: davorrunje, kumaranvpl, sternakt, davorinrusevljan, harishmohanraj, rjambrecic

CODE_OF_CONDUCT.md

@@ -6,7 +6,7 @@
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, caste, color, religion, or sexual
 identity and orientation.
 

README.md

@@ -55,7 +55,7 @@
 
 ---
 
-Welcome to FastAgency! This guide will walk you through the initial setup and usage of FastAgency, a powerful tool that leverages the [AutoGen](https://autogen-ai.github.io/autogen/) framework to quickly build applications. FastAgency is designed to be flexible and adaptable, and we plan to extend support to additional agentic frameworks such as [CrewAI](https://www.crewai.com/) in the near future. This will provide even more options for defining workflows and integrating with various AI tools.
+Welcome to FastAgency! This guide will walk you through the initial setup and usage of FastAgency, a powerful tool that leverages the AutoGen framework to quickly build applications. FastAgency is designed to be flexible and adaptable, and we plan to extend support to additional agentic frameworks such as [CrewAI](https://www.crewai.com/) in the near future. This will provide even more options for defining workflows and integrating with various AI tools.
 
 With FastAgency, you can create interactive applications using various interfaces such as a console or Mesop.
 
@@ -199,8 +199,6 @@ For Console applications, you will see a command-line prompt where you can enter
 
 We are actively working on expanding FastAgency’s capabilities. In addition to supporting AutoGen, we plan to integrate support for other frameworks, such as [CrewAI](https://www.crewai.com/), to provide more flexibility and options for building applications. This will allow you to define workflows using a variety of frameworks and leverage their unique features and functionalities.
 
-Feel free to customize your workflow and application based on your needs. For more details on configurations and additional features, refer to the [AutoGen documentation](https://autogen-ai.github.io/autogen/) and [Mesop documentation](https://google.github.io/mesop/).
-
 ---
 
 ## Stay in touch

docs/docs.py

@@ -76,12 +76,12 @@ def preview():
     """A quick server to preview a built site with translations.
 
     For development, prefer the command live (or just mkdocs serve).
-    This is here only to preview a builded site.
+    This is here only to preview a built site.
     """
     _build()
     typer.echo("Warning: this is a very simple server.")
     typer.echo("For development, use the command live instead.")
-    typer.echo("This is here only to preview a builded site.")
+    typer.echo("This is here only to preview a built site.")
     os.chdir(BUILD_DIR)
     addr, port = DEV_SERVER.split(":")
     server = HTTPServer((addr, int(port)), SimpleHTTPRequestHandler)

docs/docs/en/getting-started/contributing/docs.md

@@ -20,7 +20,7 @@ Such a contribution can be:
 * Suggestions for editing specific sections
 * Making additions
 
-You can report all this in [discussions](https://github.com/airtai/fastagency/discussions){.external-link targer="_blank"} on GitHub, start [issue](https://github.com/airtai/fastagency/issues){.external-link targer="_blank"}, or write about it in our [discord](https://discord.gg/kJjSGWrknU){.external-link targer="_blank"} group.
+You can report all this in [discussions](https://github.com/airtai/fastagency/discussions){.external-link target="_blank"} on GitHub, start [issue](https://github.com/airtai/fastagency/issues){.external-link target="_blank"}, or write about it in our [discord](https://discord.gg/kJjSGWrknU){.external-link target="_blank"} group.
 
 !!! note
     Special thanks to those who are ready to offer help with the case and help in **developing documentation**, as well as translating it into **other languages**.

docs/docs/en/getting-started/index.md

@@ -68,7 +68,7 @@ search:
 
 ---
 
-Welcome to FastAgency! This guide will walk you through the initial setup and usage of FastAgency, a powerful tool that leverages the [AutoGen](https://autogen-ai.github.io/autogen/){target="_blank"} framework to quickly build applications. FastAgency is designed to be flexible and adaptable, and we plan to extend support to additional agentic frameworks such as [CrewAI](https://www.crewai.com/){target="_blank"} in the near future. This will provide even more options for defining workflows and integrating with various AI tools.
+Welcome to FastAgency! This guide will walk you through the initial setup and usage of FastAgency, a powerful tool that leverages the AutoGen framework to quickly build applications. FastAgency is designed to be flexible and adaptable, and we plan to extend support to additional agentic frameworks such as [CrewAI](https://www.crewai.com/){target="_blank"} in the near future. This will provide even more options for defining workflows and integrating with various AI tools.
 
 With FastAgency, you can create interactive applications using various interfaces such as a console or Mesop.
 
@@ -101,6 +101,23 @@ To get started, you need to install FastAgency. You can do this using `pip`, Pyt
 
     This command installs FastAgency with support for both the Console and Mesop interfaces, providing a more comprehensive setup.
 
+!!! note "Using older AutoGen version 0.2.x"
+
+    In case you want to use an older version of AutoGen (`pyautogen` instead of `autogen` package ), please use the following pip command:
+
+    === "Console"
+        ```console
+        pip install "fastagency[pyautogen]"
+        ```
+
+        This command installs FastAgency with support for the Console interface and AutoGen framework.
+
+    === "Mesop"
+        ```console
+        pip install "fastagency[pyautogen,mesop]"
+        ```
+
+
 ### Imports
 Depending on the interface you choose, you'll need to import different modules. These imports set up the necessary components for your application:
 
@@ -375,7 +392,7 @@ In this example, we'll demonstrate how to create custom interaction with the use
 
 This section describes how to define functions for the `ConversableAgent` instances representing the student and teacher. We will also explain the differences between `MultipleChoice`, `SystemMessage`, and `TextInput`, which are used for communication between the user and agents.
 
-Let's define three functions which will be avaliable to the agents:
+Let's define three functions which will be available to the agents:
 
 #### Free Textual Tnput
 
@@ -386,7 +403,7 @@ def retrieve_exam_questions(message: Annotated[str, "Message for examiner"]) ->
     try:
         msg = TextInput(
             sender="student",
-            recepient="teacher",
+            recipient="teacher",
             prompt=message,
             suggestions=["1) Mona Lisa", "2) Innovations", "3) Florence at the time of Leonardo", "4) The Last Supper", "5) Vitruvian Man"],
         )
@@ -404,7 +421,7 @@ def write_final_answers(message: Annotated[str, "Message for examiner"]) -> str:
     try:
         msg = SystemMessage(
             sender="function call logger",
-            recepient="system",
+            recipient="system",
             message={
                 "operation": "storing final answers",
                 "content": message,
@@ -425,7 +442,7 @@ def get_final_grade(message: Annotated[str, "Message for examiner"]) -> str:
     try:
         msg = MultipleChoice(
             sender="student",
-            recepient="teacher",
+            recipient="teacher",
             prompt=message,
             choices=["A", "B", "C", "D", "F"],
         )
@@ -528,7 +545,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = TextInput(
                 sender="student",
-                recepient="teacher",
+                recipient="teacher",
                 prompt=message,
                 suggestions=["1) Mona Lisa", "2) Innovations", "3) Florence at the time of Leonardo", "4) The Last Supper", "5) Vitruvian Man"],
             )
@@ -540,7 +557,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = SystemMessage(
                 sender="function call logger",
-                recepient="system",
+                recipient="system",
                 message={
                     "operation": "storing final answers",
                     "content": message,
@@ -555,7 +572,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = MultipleChoice(
                     sender="student",
-                    recepient="teacher",
+                    recipient="teacher",
                     prompt=message,
                     choices=["A", "B", "C", "D", "F"],
             )
@@ -614,8 +631,6 @@ fastagency run
 
 We are actively working on expanding FastAgency’s capabilities. In addition to supporting AutoGen, we plan to integrate support for other frameworks, such as [CrewAI](https://www.crewai.com/){target="_blank"}, to provide more flexibility and options for building applications. This will allow you to define workflows using a variety of frameworks and leverage their unique features and functionalities.
 
-Feel free to customize your workflow and application based on your needs. For more details on configurations and additional features, refer to the [AutoGen documentation](https://autogen-ai.github.io/autogen/){target="_blank"} and [Mesop documentation](https://google.github.io/mesop/){target="_blank"}.
-
 ---
 
 ## Stay in touch

docs/docs/en/release.md

@@ -16,7 +16,7 @@ hide:
 
 ### Initial release
 
-FastAgency enables developers to quickly build testing or production-grade chat applications based on multi-agent workflow. This initial release supports [AutoGen](https://autogen-ai.github.io/autogen/) runtime for agentic workflows and simple console and [Mesop](https://google.github.io/mesop/) applications.
+FastAgency enables developers to quickly build testing or production-grade chat applications based on multi-agent workflow. This initial release supports AutoGen runtime for agentic workflows and simple console and [Mesop](https://google.github.io/mesop/) applications.
 
 ### New Contributors
 * @davorrunje made their first contribution in https://github.com/airtai/fastagency/pull/2

docs/docs/en/tutorial/custom-user-interactions/index.md

@@ -16,7 +16,7 @@ pip install "fastagency[autogen]"
 
 This section describes how to define functions for the `ConversableAgent` instances representing the student and teacher. We will also explain the differences between `MultipleChoice`, `SystemMessage`, and `TextInput`, which are used for communication between the user and agents.
 
-Let's define three functions which will be avaliable to the agents:
+Let's define three functions which will be available to the agents:
 
 ### Free Textual Tnput
 
@@ -27,7 +27,7 @@ def retrieve_exam_questions(message: Annotated[str, "Message for examiner"]) ->
     try:
         msg = TextInput(
             sender="student",
-            recepient="teacher",
+            recipient="teacher",
             prompt=message,
             suggestions=["1) Mona Lisa", "2) Innovations", "3) Florence at the time of Leonardo", "4) The Last Supper", "5) Vitruvian Man"],
         )
@@ -45,7 +45,7 @@ def write_final_answers(message: Annotated[str, "Message for examiner"]) -> str:
     try:
         msg = SystemMessage(
             sender="function call logger",
-            recepient="system",
+            recipient="system",
             message={
                 "operation": "storing final answers",
                 "content": message,
@@ -66,7 +66,7 @@ def get_final_grade(message: Annotated[str, "Message for examiner"]) -> str:
     try:
         msg = MultipleChoice(
             sender="student",
-            recepient="teacher",
+            recipient="teacher",
             prompt=message,
             choices=["A", "B", "C", "D", "F"],
         )
@@ -169,7 +169,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = TextInput(
                 sender="student",
-                recepient="teacher",
+                recipient="teacher",
                 prompt=message,
                 suggestions=["1) Mona Lisa", "2) Innovations", "3) Florence at the time of Leonardo", "4) The Last Supper", "5) Vitruvian Man"],
             )
@@ -181,7 +181,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = SystemMessage(
                 sender="function call logger",
-                recepient="system",
+                recipient="system",
                 message={
                     "operation": "storing final answers",
                     "content": message,
@@ -196,7 +196,7 @@ def exam_learning(io: Chatable, initial_message: str, session_id: str) -> str:
         try:
             msg = MultipleChoice(
                     sender="student",
-                    recepient="teacher",
+                    recipient="teacher",
                     prompt=message,
                     choices=["A", "B", "C", "D", "F"],
             )

docs/mkdocs.yml

@@ -60,7 +60,7 @@ theme:
     - content.tabs.link          # sync total page tabs
     # - content.tooltips           # (insiders) improved tooltips
     - content.code.copy
-    - content.code.annotate      # code anotations with # (1)
+    - content.code.annotate      # code annotations with # (1)
     # - content.code.select        # (insiders) highlight line under cursor
     - content.action.edit        # add edit btn at every page