Fix links, add index content, move contrib (#70)

docs/src/conf.py

@@ -40,6 +40,8 @@ nb_execution_timeout = 60
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
+html_title = "AGNext"
+
 html_theme = "furo"
 html_static_path = []
 

docs/src/core-concepts/agent.md

@@ -6,7 +6,7 @@ with each others.
 
 ## TypeRoutedAgent
 
-`agnext.components.TypeRoutedAgent`
+{py:class}`agnext.components.TypeRoutedAgent`
 is a base class for building custom agents. It provides
 a simple API for associating message types with message handlers.
 Here is an example of simple agent that reacts to `TextMessage`:
@@ -17,7 +17,7 @@ from agnext.components import TypeRoutedAgent, message_handler
 from agnext.core import AgentRuntime, CancellationToken
 
 class MyAgent(TypeRoutedAgent):
-    
+
     @message_handler()
     async def on_text_message(self, message: TextMessage, cancellation_token: CancellationToken)) -> None:
         await self._publish(TextMessage(content=f"I received this message: ({message.content}) from {message.source}"))

docs/src/core-concepts/memory.md

@@ -4,4 +4,4 @@ Memory is a collection of data corresponding to the conversation history
 of an agent.
 Data in meory can be just a simple list of all messages, or a sightly more
 realistic one which provides a view of the last N messages
-(`agnext.chat.memory.BufferedChatMemory`).
+({py:class}`agnext.chat.memory.BufferedChatMemory`).

docs/src/core-concepts/runtime.md

@@ -8,5 +8,5 @@ debugging multi-agent interactions.
 
 Further readings:
 
-1. `agnext.core.AgentRuntime`
+1. {py:class}`agnext.core.AgentRuntime`
-2. `agnext.application.SingleThreadedAgentRuntime`
+2. {py:class}`agnext.application.SingleThreadedAgentRuntime`

docs/src/index.rst

@@ -1,13 +1,22 @@
-agnext
+AGNext
 ------
 
+AGNext is a framework for building multi-agent applications. It is designed to be easy to use, flexible, and scalable.
+
+At a high level it provides both a framework for inter-agent communication and a set of components for building and managing agents.
+
+:doc:`Agents <core-concepts/agent>` are hosted by and managed by a :doc:`runtime <core-concepts/runtime>`.
+AGNext supports both RPC or event based based
+communication between agents, allowing for a :doc:`diverse set of agent patterns
+<core-concepts/patterns>`. AGNext provides default agent implementations for
+common uses, such as chat completion agents, but also allows for fully custom agents.
+
 .. toctree::
     :caption: Getting started
     :hidden:
 
     getting-started/installation
     getting-started/tutorial
-    getting-started/contributing
 
 .. toctree::
     :caption: Core Concepts
@@ -34,3 +43,10 @@ agnext
     reference/agnext.application
     reference/agnext.chat
     reference/agnext.core
+
+.. toctree::
+    :caption: Other
+    :hidden:
+
+    contributing
+