Migrate Documentation from Docusaurus to Mintlify

.github/workflows/deploy-website-mintlify.yml

@@ -0,0 +1,119 @@
+name: mintlify docs
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - "autogen/**"
+      - "website/**"
+      - ".github/workflows/deploy-website-mintlify.yml"
+  push:
+    branches: [main]
+    paths:
+      - "autogen/**"
+      - "website/**"
+      - ".github/workflows/deploy-website-mintlify.yml"
+  workflow_dispatch:
+  merge_group:
+    types: [checks_requested]
+permissions:
+  contents: write
+jobs:
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: website
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pydoc-markdown pyyaml termcolor nbconvert
+          # Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown.
+          pip install databind.core==4.4.2 databind.json==4.4.2
+
+      - name: Install quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Generate API documentation
+        run: |
+          python ./process_api_reference.py
+        working-directory: website
+
+      - name: Convert Jupyter notebooks to MDX
+        run: |
+          python ./process_notebooks.py render
+        working-directory: website
+
+      - name: Prepare website content
+        run: |
+          # Create a temporary directory for filtered content
+          mkdir -p temp_website
+
+          # Copy files except .ipynb, node_modules, .quarto, .gitignore, and temp_website
+          find . -type f -not -path "*/node_modules/*" -not -path "*/.quarto/*" -not -path "./temp_website/*" -not -name "*.ipynb" -not -name ".gitignore" -exec cp --parents {} temp_website/ \;
+
+  mintlify-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: website
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pydoc-markdown pyyaml termcolor nbconvert
+          # Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown.
+          pip install databind.core==4.4.2 databind.json==4.4.2
+
+      - name: Install quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Generate API documentation
+        run: |
+          python ./process_api_reference.py
+        working-directory: website
+
+      - name: Convert Jupyter notebooks to MDX
+        run: |
+          python ./process_notebooks.py render
+        working-directory: website
+
+      - name: Prepare website content
+        run: |
+          # Create a temporary directory for filtered content
+          mkdir -p temp_website
+
+          # Copy files except .ipynb, node_modules, .quarto, .gitignore, and temp_website
+          find . -type f -not -path "*/node_modules/*" -not -path "*/.quarto/*" -not -path "./temp_website/*" -not -name "*.ipynb" -not -name ".gitignore" -exec cp --parents {} temp_website/ \;
+
+      - name: Deploy to Mintlify
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: mintlify-pages
+          publish_dir: ./website/temp_website

.github/workflows/deploy-website.yml

@@ -1,121 +1,47 @@
-name: docs
+name: Deploy Redirect Page
 
 on:
-  pull_request:
-    branches: [main]
-    path:
-      - "autogen/*"
-      - "website/*"
-      - ".github/workflows/deploy-website.yml"
   push:
     branches: [main]
-    path:
-      - "autogen/*"
-      - "website/*"
+    paths:
       - ".github/workflows/deploy-website.yml"
   workflow_dispatch:
-  merge_group:
-    types: [checks_requested]
 permissions:
   contents: write
 jobs:
-  checks:
-    if: github.event_name != 'push'
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: website
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          lfs: true
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18.x
-      - name: setup python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-      - name: pydoc-markdown install
-        run: |
-          python -m pip install --upgrade pip
-          pip install pydoc-markdown pyyaml termcolor
-          # Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown.
-          pip install databind.core==4.4.2 databind.json==4.4.2
-      - name: pydoc-markdown run
-        run: |
-          pydoc-markdown
-      - name: quarto install
-        working-directory: ${{ runner.temp }}
-        run: |
-          wget -q https://github.com/quarto-dev/quarto-cli/releases/download/v1.5.23/quarto-1.5.23-linux-amd64.tar.gz
-          tar -xzf quarto-1.5.23-linux-amd64.tar.gz
-          echo "$(pwd)/quarto-1.5.23/bin/" >> $GITHUB_PATH
-      - name: Process notebooks
-        run: |
-          python process_notebooks.py render
-      - name: Test Build
-        run: |
-          if [ -e yarn.lock ]; then
-          yarn install --frozen-lockfile --ignore-engines
-          yarn build
-          elif [ -e package-lock.json ]; then
-          npm ci
-          npm run build
-          else
-          npm i --legacy-peer-deps
-          npm run build
-          fi
-  gh-release:
-    if: github.event_name != 'pull_request'
+  deploy:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: website
     steps:
-      - uses: actions/checkout@v4
-        with:
-          lfs: true
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18.x
-      - name: setup python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-      - name: pydoc-markdown install
-        run: |
-          python -m pip install --upgrade pip
-          pip install pydoc-markdown pyyaml termcolor
-          # Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown.
-          pip install databind.core==4.4.2 databind.json==4.4.2
-      - name: pydoc-markdown run
-        run: |
-          pydoc-markdown
-      - name: quarto install
-        working-directory: ${{ runner.temp }}
-        run: |
-          wget -q https://github.com/quarto-dev/quarto-cli/releases/download/v1.5.23/quarto-1.5.23-linux-amd64.tar.gz
-          tar -xzf quarto-1.5.23-linux-amd64.tar.gz
-          echo "$(pwd)/quarto-1.5.23/bin/" >> $GITHUB_PATH
-      - name: Process notebooks
-        run: |
-          python process_notebooks.py render
-      - name: Build website
-        run: |
-          if [ -e yarn.lock ]; then
-          yarn install --frozen-lockfile --ignore-engines
-          yarn build
-          elif [ -e package-lock.json ]; then
-          npm ci
-          npm run build
-          else
-          npm i --legacy-peer-deps
-          npm run build
-          fi
+      # Step 1: Check out the repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Step 2: Create a fresh redirect HTML file
+      - name: Create redirect HTML
+        run: |
+          mkdir -p dist
+          cat > dist/index.html << 'EOF'
+          <!DOCTYPE html>
+          <html>
+            <head>
+              <meta charset="UTF-8">
+              <meta http-equiv="refresh" content="0; url=https://ag2ai.mintlify.app">
+              <script>window.location.href = "https://ag2ai.mintlify.app";</script>
+              <title>Page Redirection</title>
+            </head>
+            <body>
+              If you are not redirected automatically, follow this <a href="https://ag2ai.mintlify.app">link to the new documentation</a>.
+            </body>
+          </html>
+          EOF
+
+      # Step 3: Deploy to gh-pages branch
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          # Build output to publish to the `gh-pages` branch:
-          publish_dir: ./website/build
+          publish_dir: ./dist
+          force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: 'Deploy redirect page'

autogen/oai/anthropic.py

@@ -11,6 +11,7 @@
 Install the `anthropic` package by running `pip install --upgrade anthropic`.
 - https://docs.anthropic.com/en/docs/quickstart-guide
 
+```python
 import autogen
 
 config_list = [
@@ -22,12 +23,14 @@
 ]
 
 assistant = autogen.AssistantAgent("assistant", llm_config={"config_list": config_list})
+```
 
 Example usage for Anthropic Bedrock:
 
 Install the `anthropic` package by running `pip install --upgrade anthropic`.
 - https://docs.anthropic.com/en/docs/quickstart-guide
 
+```python
 import autogen
 
 config_list = [
@@ -42,7 +45,7 @@
 ]
 
 assistant = autogen.AssistantAgent("assistant", llm_config={"config_list": config_list})
-
+```
 """
 
 from __future__ import annotations

autogen/oai/bedrock.py

@@ -11,6 +11,7 @@
 Install the `boto3` package by running `pip install --upgrade boto3`.
 - https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html
 
+```python
 import autogen
 
 config_list = [
@@ -25,7 +26,7 @@
 ]
 
 assistant = autogen.AssistantAgent("assistant", llm_config={"config_list": config_list})
-
+```
 """
 
 from __future__ import annotations

autogen/retrieve_utils.py

@@ -52,6 +52,7 @@
     "yaml",
     "yml",
     "pdf",
+    "mdx",
 ]
 UNSTRUCTURED_FORMATS = [
     "doc",

notebook/agentchat_custom_model.ipynb

@@ -441,7 +441,7 @@
  ],
  "metadata": {
   "front_matter": {
-   "description": "Define and laod a custom model",
+   "description": "Define and load a custom model",
    "tags": [
     "integration",
     "custom model"

test/test_retrieve_utils.py

@@ -226,7 +226,7 @@ def test_retrieve_utils(self):
             dir_path="./website/docs",
             client=client,
             collection_name="autogen-docs",
-            custom_text_types=["txt", "md", "rtf", "rst"],
+            custom_text_types=["txt", "md", "rtf", "rst", "mdx"],
             get_or_create=True,
         )
         results = query_vector_db(

website/.gitignore

@@ -9,7 +9,7 @@ package-lock.json
 .docusaurus
 .cache-loader
 docs/reference
-/docs/notebooks
+/notebooks
 
 docs/tutorial/*.mdx
 docs/tutorial/**/*.png

website/README.md

@@ -1,22 +1,15 @@
 # Website
 
-This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
+This website is built using [Mintlify](https://mintlify.com/docs/quickstart), a modern website generator.
 
 ## Prerequisites
 
-To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/), and then installing [Yarn](https://classic.yarnpkg.com/en/).
-On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:
-
-```console
-npm install --global yarn
-```
+To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/) and [Mintlify CLI](https://www.npmjs.com/package/mintlify)
 
 ## Installation
 
 ```console
 pip install pydoc-markdown pyyaml colored
-cd website
-yarn install
 ```
 
 ### Install Quarto
@@ -34,7 +27,13 @@ Navigate to the `website` folder and run:
 ```console
 pydoc-markdown
 python ./process_notebooks.py render
-yarn start
+npm install
+```
+
+Run the following command at the root of your documentation (where mint.json is)
+
+```console
+npm run mintlify:dev
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.