Merge pull request #2 from SandhyaKaliappan/polishing

Update docs build and serve scripts

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

@@ -49,15 +49,9 @@ jobs:
       - 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: Build documentation
+        run: ./scripts/docs_build.sh
+        working-directory: .
 
       - name: Prepare website content
         run: |
@@ -95,15 +89,9 @@ jobs:
       - 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: Build documentation
+        run: ./scripts/docs_build.sh
+        working-directory: .
 
       - name: Prepare website content
         run: |

scripts/docs_build.sh

@@ -3,7 +3,14 @@
 set -e
 set -x
 
-cd website &&
-    yarn install --frozen-lockfile --ignore-engines &&
-    pydoc-markdown &&
-    yarn build
+# Function to build documentation
+docs_build() {
+    cd website &&
+        python ./process_api_reference.py &&
+        python ./process_notebooks.py render
+}
+
+# Execute the function only if the script is run directly
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+    docs_build
+fi

scripts/docs_serve.sh

@@ -3,7 +3,16 @@
 set -e
 set -x
 
-cd website &&
-    yarn install --frozen-lockfile --ignore-engines &&
-    pydoc-markdown &&
-    yarn start
+# Source the docs_build.sh script from the same directory
+source "$(dirname "$0")/docs_build.sh"
+
+# Run the docs_build function from docs_build.sh
+docs_build
+
+# Install npm packages
+echo "Running npm install..."
+npm install
+
+# Add the command to serve the documentation
+echo "Serving documentation..."
+npm run mintlify:dev

website/README.md

@@ -25,11 +25,7 @@ pip install pydoc-markdown pyyaml termcolor nbclient
 3. Finally, run the following commands to build and serve the documentation:
 
 ```console
-cd website
-python ./process_api_reference.py
-python ./process_notebooks.py render
-npm install
-npm run mintlify:dev
+./scripts/docs_serve.sh
 ```
 
 The last command starts a local development server and opens up a browser window.
@@ -52,11 +48,7 @@ docker run -it -p 8081:3000 -v $(pwd):/home/autogen/ag2 ag2ai_dev_img bash
 Once at the CLI in Docker run the following commands:
 
 ```console
-cd website
-python ./process_api_reference.py
-python ./process_notebooks.py render
-npm install
-npm run mintlify:dev
+./scripts/docs_serve.sh
 ```
 
 Once done you should be able to access the documentation at `http://127.0.0.1:8081`