Upgrade docusaurus (#1101)

* Preparing content for MDX v3

* upgrade dcusarus to v3

* upgrade to v3

* merge main to branch

* space

* change node version to 18

* merge main

* change setup-node version

* bug fix: added escape when needed

* added escape characters in docstrings

* upgraded docusaurus to 3.0.1

* polishing

* restored commented out link

* rename file

* removed backtick

* Add support for MD files in Docusaurus

* Add support for MD files in Docusaurus

* Add support for MD files in Docusaurus

* polishing

* cleanup

* cleanup

* cleanup

* cleanup

* cleanup

* cleanup

* cleanup

* merge with main and build scripts added

---------

Co-authored-by: Davor Runje <davor@airt.ai>
Co-authored-by: Shaokun Zhang <shaokunzhang529@gmail.com>
Co-authored-by: Victor Dibia <victordibia@microsoft.com>

.github/workflows/deploy-website.yml

@@ -26,9 +26,9 @@ jobs:
         working-directory: website
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14.x
+          node-version: 18.x
       - name: setup python
         uses: actions/setup-python@v4
         with:
@@ -60,9 +60,9 @@ jobs:
         working-directory: website
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14.x
+          node-version: 18.x
       - name: setup python
         uses: actions/setup-python@v4
         with:

autogen/oai/completion.py

@@ -132,7 +132,7 @@ class Completion(openai_Completion):
             seed (int, Optional): The integer identifier for the pseudo seed.
                 Results corresponding to different seeds will be cached in different places.
             cache_path (str, Optional): The root path for the cache.
-                The complete cache path will be {cache_path}/{seed}.
+                The complete cache path will be {cache_path_root}/{seed}.
         """
         cls.cache_seed = seed
         cls.cache_path = f"{cache_path_root}/{seed}"
@@ -145,7 +145,7 @@ class Completion(openai_Completion):
             seed (int, Optional): The integer identifier for the pseudo seed.
                 If omitted, all caches under cache_path_root will be cleared.
             cache_path (str, Optional): The root path for the cache.
-                The complete cache path will be {cache_path}/{cache_seed}.
+                The complete cache path will be {cache_path_root}/{seed}.
         """
         if seed is None:
             shutil.rmtree(cache_path_root, ignore_errors=True)

scripts/docs_build.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+cd website &&
+    yarn install --frozen-lockfile --ignore-engines &&
+    pydoc-markdown &&
+    yarn build

scripts/docs_serve.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+cd website &&
+    yarn install --frozen-lockfile --ignore-engines &&
+    pydoc-markdown &&
+    yarn start

website/docs/Use-Cases/enhanced_inference.md

@@ -6,7 +6,7 @@ There are a number of benefits of using `autogen` to perform inference: performa
 
 ## Tune Inference Parameters (for openai<1)
 
-Find a list of examples in this page: [Tune Inference Parameters Examples](../Examples.md#tune-inference-hyperparameters)
+Find a list of examples in this page: [Tune Inference Parameters Examples](../Examples.md#inference-hyperparameters-tuning)
 
 ### Choices to optimize
 

website/docusaurus.config.js

@@ -12,6 +12,9 @@ module.exports = {
   favicon: "img/ag.ico",
   organizationName: "Microsoft", // Usually your GitHub org/user name.
   projectName: "AutoGen", // Usually your repo name.
+  markdown: {
+    format: 'detect', // Support for MD files with .md extension
+  },
   themeConfig: {
     navbar: {
       title: "AutoGen",

website/package.json

@@ -25,23 +25,28 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4193",
-    "@docusaurus/preset-classic": "0.0.0-4193",
+    "@docusaurus/core": "^3.1.0",
+    "@docusaurus/preset-classic": "^3.1.0",
     "@easyops-cn/docusaurus-search-local": "^0.21.1",
-    "@mdx-js/react": "^1.6.21",
+    "@mdx-js/react": "^3.0.0",
     "@svgr/webpack": "^5.5.0",
     "antd": "^5.11.5",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
     "hast-util-is-element": "1.1.0",
+    "joi": "17.6.0",
     "minimatch": "3.0.5",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "rehype-katex": "4",
     "remark-math": "3",
     "trim": "^0.0.3",
     "url-loader": "^4.1.1"
   },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "^3.1.0",
+    "@docusaurus/types": "^3.1.0"
+  },
   "browserslist": {
     "production": [
       ">0.5%",

website/pydoc-markdown.yml

@@ -13,4 +13,4 @@ renderer:
   relative_sidebar_path: sidebar.json
   sidebar_top_level_label: Reference
   markdown:
-    escape_html_in_docstring: false
+    escape_html_in_docstring: true

website/sidebars.js

@@ -14,7 +14,6 @@
     'Getting-Started',
     'Installation',
     {'Use Cases': [{type: 'autogenerated', dirName: 'Use-Cases'}]},
-    {'Examples': [{type: 'autogenerated', dirName: 'Examples'}]},
     'Contribute',
     'Research',
   ],