Update installation instructions and banner for release (#625)

python/packages/autogen-core/docs/src/agentchat-user-guide/guides/quickstart.ipynb

@@ -0,0 +1,40 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Quick Start\n",
+    "\n",
+    ":::{note}\n",
+    "See [here](pkg-info-autogen-agentchat) for installation instructions.\n",
+    ":::\n",
+    "\n",
+    ":::{warning}\n",
+    "🚧 Under construction 🚧\n",
+    ":::"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "agnext",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

python/packages/autogen-core/docs/src/agentchat-user-guide/index.md

@@ -7,6 +7,14 @@ myst:
 
 # AgentChat
 
-```{note}
+```{warning}
 🚧 Under construction 🚧
 ```
+
+```{toctree}
+:caption: Getting Started
+:maxdepth: 1
+:hidden:
+
+guides/quickstart
+```

python/packages/autogen-core/docs/src/conf.py

@@ -98,6 +98,7 @@ html_theme_options = {
             "icon": "fa-custom fa-pypi",
         },
     ],
+    "announcement": '🚧 AutoGen 0.4 is a <a href="#">work in progress</a>, learn more about what\'s new and different <a href="#">here</a>. To continue using the latest stable version, please visit the <a href="#">0.3 documentation</a>. 🚧',
 }
 
 html_js_files = ["custom-icon.js"]
@@ -119,6 +120,8 @@ autodoc_default_options = {
     "undoc-members": True,
 }
 
+
+
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 

python/packages/autogen-core/docs/src/core-user-guide/guides/installation.md

@@ -1,37 +0,0 @@
-# Installation
-
-The repo is private, so the installation process is a bit more involved than usual.
-
-## Option 1: Install from a local clone
-
-Make a clone of the repo:
-
-```sh
-git clone https://github.com/microsoft/agnext.git
-```
-
-You can install the package by running:
-
-```sh
-cd agnext/python/packages/autogen-core
-pip install .
-```
-
-## Option 2: Install from GitHub
-
-To install the package from GitHub, you will need to authenticate with GitHub.
-
-```sh
-GITHUB_TOKEN=$(gh auth token)
-pip install "git+https://oauth2:$GITHUB_TOKEN@github.com/microsoft/agnext.git#subdirectory=python/packages/autogen-core"
-```
-
-### Using a Personal Access Token instead of `gh` CLI
-
-If you don't have the `gh` CLI installed, you can generate a personal access token from the GitHub website.
-
-1. Go to [New fine-grained personal access token](https://github.com/settings/personal-access-tokens/new)
-2. Set `Resource Owner` to `Microsoft`
-3. Set `Repository Access` to `Only select repositories` and select `Microsoft/agnext`
-4. Set `Permissions` to `Repository permissions` and select `Contents: Read`
-5. Use the generated token for `GITHUB_TOKEN` in the commad above

python/packages/autogen-core/docs/src/core-user-guide/guides/quickstart.ipynb

@@ -6,6 +6,10 @@
    "source": [
     "# Quick Start\n",
     "\n",
+    ":::{note}\n",
+    "See [here](pkg-info-autogen-core) for installation instructions.\n",
+    ":::\n",
+    "\n",
     "Before diving into the core APIs, let's start with a simple example of two\n",
     "agents creating a plot of Tesla's and Nvidia's stock returns.\n",
     "\n",

python/packages/autogen-core/docs/src/core-user-guide/index.md

@@ -37,7 +37,6 @@ Key features of AutoGen core include:
 :maxdepth: 1
 :hidden:
 
-guides/installation
 guides/quickstart
 ```
 

python/packages/autogen-core/docs/src/index.md

@@ -46,9 +46,11 @@ Task driven, high level APIs for building multi-agent systems. Including group c
 Built with <i>core</i>.
 <p>
 
-```sh
+<div class="highlight-sh notranslate"><div class="highlight"><pre id="codecell1" tabindex="-1">
-pip install autogen-agentchat
+<a href="/packages/index.html#pkg-info-autogen-agentchat">Installation instructions</a>
-```
+</pre>
+</div>
+</div>
 
 <button onclick="location.href='agentchat-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
 <button onclick="location.href='reference/python/autogen_agentchat/autogen_agentchat.html'" type="button" class="btn btn-outline-secondary">API Reference</button>
@@ -69,9 +71,11 @@ pip install autogen-agentchat
 Primitive building blocks for creating asynchronous, event driven multi-agent systems.
 <p>
 
-```sh
+<div class="highlight-sh notranslate"><div class="highlight"><pre id="codecell1" tabindex="-1">
-pip install autogen-core
+<a href="/packages/index.html#pkg-info-autogen-core">Installation instructions</a>
-```
+</pre>
+</div>
+</div>
 
 <button onclick="location.href='core-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
 <button onclick="location.href='reference/python/autogen_core/autogen_core.html'" type="button" class="btn btn-outline-secondary">API Reference</button>

python/packages/autogen-core/docs/src/packages/index.md

@@ -20,42 +20,63 @@ myst:
 
 # Packages
 
+(pkg-info-autogen-agentchat)=
+
 :::{card} {fas}`people-group;pst-color-primary` AutoGen AgentChat
 :class-title: card-title
 
 Library that is at a similar level of abstraction as AutoGen 0.2, including default agents and group chat.
 
 ```sh
-pip install autogen-agentchat
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-core
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-ext
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-agentchat
 ```
 
-[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat/autogen_agentchat.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-agentchat)
+```{note}
+This package is a work in progress, it will be available on PyPI when it is ready.
+```
+
+[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat/autogen_agentchat.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-agentchat)
 :::
 
+(pkg-info-autogen-core)=
+
 :::{card} {fas}`cube;pst-color-primary` AutoGen Core
 :class-title: card-title
 
 Implements the core functionality of the AutoGen framework, providing basic building blocks for creating multi-agent systems.
 
 ```sh
-pip install autogen-core
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-core
 ```
 
-[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-core)
+```{note}
+This package is a work in progress, it will be available on PyPI when it is ready.
+```
+[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-core)
 :::
 
+(pkg-info-autogen-ext)=
+
 :::{card} {fas}`puzzle-piece;pst-color-primary` AutoGen Extensions
 :class-title: card-title
 
 Implementations of core components that interface with external services, or use extra dependencies. For example, Docker based code execution.
 
 ```sh
-pip install autogen-ext
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-core
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-ext
 ```
 
-[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-ext/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext/autogen_ext.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-ext)
+```{note}
+This package is a work in progress, it will be available on PyPI when it is ready.
+```
+
+[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext/autogen_ext.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-ext)
 :::
 
+(pkg-info-autogen-team-one)=
 
 :::{card} {fas}`users;pst-color-primary` Team One
 :class-title: card-title
@@ -63,12 +84,19 @@ pip install autogen-ext
 A generalist multi-agent softbot utilizing five agents to tackle intricate tasks involving multi-step planning and real-world actions.
 
 ```sh
-pip install autogen-team-one
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-core
+pip install git+https://github.com/microsoft/autogen.git#subdirectory=python/packages/autogen-team-one
 ```
 
-[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-team-one/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/index.md) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/team-one)
+```{note}
+This package is a work in progress, it will be available on PyPI when it is ready.
+```
+
+[{fas}`file-code;pst-color-primary` API Reference](/reference/index.md) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/team-one)
 :::
 
+(pkg-info-autogenbench)=
+
 :::{card} {fas}`chart-bar;pst-color-primary` AutoGen Bench
 :class-title: card-title