fix: Updated examples and relevant integrations & examples in the documentation pages (#1029)

* dawn of the new `openai-agents`

* the first purge

* the purge

* the purge anarchy

* the purge election year

* anthropic good

* openai-agents good

* smolagent @Dwij1704 fix me no touch git no conflict

* watsonx @Dwij1704 make good

* microsoft pyautogen good; dis real autogen?

* grok is this true?

* crewai good @areibman happy

* i so sorry i leave you behind

* gemini good @AtomSilverman happy

* langchain good devs unhappy

* litellm good @areibman happy too

* the purge forever

* openai good me happy

* ag2 good; dis real autogen?

* docs tell how to set api keys

* The Notebook(s)

* Gavin: "Behold—our fresh logo. It signifies innovation, synergy, and exponential growth."

* dem docs be sexy again

* quick lang fix

* quickstart vroooom

* the last one

* GH copilot happy :)

* oh that damn ```

* oh my `\n`

* now i know why i failed in spelling bee

* the last one

* script kiddie

* README.md examples

* new action new problems

* me forget v2

* add source file comment

* make action better

* better reorder

* redundant content

* make action more efficient using `awk`

* script overhaul

* rename google adk example

* correct README.md

* push PR only on merge

* remove redundant code from script

* use github context in action

* make branch name easier

* ag2 comes first in alphabetical order

* purge `mode: wide`

* its `agents_sdk` now

* too big tool notebook

* google looking nice and dandy

* latest and clean integrations docs

* wrong line in place

* python scripts with README files with ❤️ for @tcdent

* ruff y u so rough

* fix for notebook json

Author: dot-agi

.github/workflows/add-notebook-examples-to-docs.yml

@@ -4,11 +4,11 @@ on:
   push:
     branches:
       - main
+      # TODO: Remove this branch once the workflow is stable
+      - fix/examples-cleanup
     paths:
       - 'examples/**'
-      - 'docs/v1/examples/**'
-      - '.github/workflows/add-notebook-examples-to-docs.yml'
-
+      - 'docs/v2/examples/**'
   workflow_dispatch:
 
 permissions:
@@ -21,49 +21,118 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: '3.x'
 
       - name: Install dependencies
-        run: |
-          pip install jupyter nbconvert
+        run: pip install jupyter nbconvert
 
-      - name: Convert notebooks to markdown and add to docs
+      - name: Detect and process notebooks
+        id: process
         run: |
-          set -x  # Enable debug mode
-          for file in docs/v1/examples/*.mdx; do
-            echo "Processing file: $file"
-            source_file=$(grep -oP '(?<=\{/\*  SOURCE_FILE: ).*(?=  \*/\})' "$file" || true)
-            if [[ -z "$source_file" ]]; then
-              continue
+          # Determine comparison range
+          case "${{ github.event_name }}" in
+            "push")
+              BASE_SHA="${{ github.event.before }}"
+              [[ "$BASE_SHA" == "0000000000000000000000000000000000000000" ]] && BASE_SHA="$(git hash-object -t tree /dev/null)"
+              HEAD_SHA="${{ github.event.after }}"
+              ;;
+            "pull_request")
+              BASE_SHA="${{ github.event.pull_request.base.sha }}"
+              HEAD_SHA="${{ github.event.pull_request.head.sha }}"
+              ;;
+            "workflow_dispatch")
+              git fetch origin "${{ github.event.repository.default_branch }}" --depth=50
+              BASE_SHA="origin/${{ github.event.repository.default_branch }}"
+              HEAD_SHA="HEAD"
+              ;;
+            *)
+              exit 1
+              ;;
+          esac
+          
+          # Get changed files and filter in one pass
+          CHANGED_FILES=$(git diff --name-only "$BASE_SHA" "$HEAD_SHA")
+          
+          # Use arrays for better performance
+          declare -A notebooks_set
+          
+          # Process notebooks directly from changed files
+          while IFS= read -r file; do
+            if [[ "$file" =~ ^examples/.*\.ipynb$ ]]; then
+              notebooks_set["$file"]=1
+            elif [[ "$file" =~ ^docs/v2/examples/.*\.mdx$ ]] && [[ -f "$file" ]]; then
+              # Extract source notebook from MDX file
+              source_notebook=$(grep -oP '(?<=SOURCE_FILE: )[^ ]+' "$file" 2>/dev/null || true)
+              if [[ -n "$source_notebook" && -f "$source_notebook" ]]; then
+                notebooks_set["$source_notebook"]=1
+              fi
             fi
-            echo "Source file: $source_file"
-            if [[ -f "$source_file" ]]; then
-              echo "Converting notebook to markdown"
-              jupyter nbconvert --to markdown "$source_file" || { echo "Error: Failed to convert $source_file" >&2; continue; }
-              markdown_file="${source_file%.ipynb}.md"
-              echo "Removing existing content after {/* SOURCE_FILE: ... */}"
-              sed -i '\#{/\*  SOURCE_FILE:#,$d' "$file"
-              echo "Appending markdown to $file"
-              echo -e "{/*  SOURCE_FILE: $source_file  */}\n" >> "$file"
-              cat "$markdown_file" >> "$file" || { echo "Error: Failed to append markdown to $file" >&2; continue; }
-              rm "$markdown_file" || { echo "Error: Failed to remove $markdown_file" >&2; continue; }
+          done <<< "$CHANGED_FILES"
+          
+          # Exit if no notebooks found
+          [[ ${#notebooks_set[@]} -eq 0 ]] && exit 0
+          
+          # Process each notebook and track results
+          failed_count=0
+          processed_notebooks=""
+          for notebook in "${!notebooks_set[@]}"; do
+            if python examples/generate_documentation.py "$notebook"; then
+              processed_notebooks="$processed_notebooks$notebook"$'\n'
             else
-              echo "Error: Source file not found: $source_file" >&2
+              ((failed_count++))
             fi
           done
+          
+          [[ $failed_count -gt 0 ]] && exit 1
+          
+          # Get modified files for PR description
+          modified_files=$(git status --porcelain | grep -E '^\s*[AM]' | awk '{print $2}' | sort)
+          
+          # Save outputs for PR
+          echo "processed_notebooks<<EOF" >> $GITHUB_OUTPUT
+          echo "$processed_notebooks" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+          
+          echo "modified_files<<EOF" >> $GITHUB_OUTPUT
+          echo "$modified_files" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v7
         with:
-          committer: Howard Gil <howardbgil@gmail.com>
-          commit-message: GitHub Action - Update examples in docs from notebooks
-          title: GitHub Action - Update examples in docs from notebooks
-          body: Changes detected in examples/** or docs/v1/examples/** triggered an update of the docs/v1/examples/**.mdx files to incorporate markdown from the corresponding notebook in examples/**.
-          branch: update-examples-in-docs-from-notebooks
+          token: ${{ secrets.GITHUB_TOKEN }}
+          committer: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
+          author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
+          commit-message: "docs: update examples from notebooks"
+          title: "docs: update examples from notebooks"
+          body: |
+            Updates documentation examples from their source notebooks.
+            
+            **Triggered by:** @${{ github.actor }}
+            **Event:** ${{ github.event_name }}
+            ${{ steps.process.outputs.processed_notebooks && format('
+
+            ## Processed Notebooks
+            ```
+            {0}
+            ```', steps.process.outputs.processed_notebooks) || '' }}
+            ${{ steps.process.outputs.modified_files && format('
+
+            ## Modified Files
+            ```
+            {0}
+            ```', steps.process.outputs.modified_files) || '' }}
+          branch: update-examples-docs
           delete-branch: true
-          assignees: HowieG,siyangqiu,bboynton97,areibman
-          reviewers: HowieG,siyangqiu,bboynton97,areibman
+          # TODO: Uncomment for production use
+          # assignees: the-praxs,bboynton97,areibman
+          # reviewers: the-praxs,bboynton97,areibman
+          # TODO: Remove this once the workflow is stable
+          assignees: the-praxs
+          reviewers: the-praxs

.github/workflows/test-notebooks.yml

@@ -222,7 +222,7 @@ Build multi-agent systems with tools, handoffs, and guardrails. AgentOps nativel
 pip install openai-agents
 ```
 
-- [AgentOps integration example](https://docs.agentops.ai/v1/integrations/agentssdk)
+- [AgentOps integration example](https://docs.agentops.ai/v1/integrations/agents_sdk)
 - [Official OpenAI Agents SDK documentation](https://openai.github.io/openai-agents-python/)
 
 ### CrewAI 🛶

README.md

@@ -95,7 +95,7 @@
     {
       "group": "Integrations",
       "pages": [
-        "v1/integrations/agentssdk",
+        "v1/integrations/agents_sdk",
         "v1/integrations/ai21",
         "v1/integrations/anthropic",
         "v1/integrations/autogen",
@@ -168,16 +168,17 @@
       "group": "Integrations",
       "pages": [
         "v2/integrations/ag2",
-        "v2/integrations/autogen",
         "v2/integrations/anthropic",
+        "v2/integrations/autogen",
         "v2/integrations/crewai",
         "v2/integrations/google_adk",
-        "v2/integrations/gemini",
+        "v2/integrations/google_generative_ai",
         "v2/integrations/langchain",
         "v2/integrations/litellm",
         "v2/integrations/openai",
-        "v2/integrations/agentssdk",
-        "v2/integrations/ibm_watsonx_ai"
+        "v2/integrations/agents_sdk",
+        "v2/integrations/ibm_watsonx_ai",
+        "v2/integrations/xai"
       ],
       "version": "v2"
     },

docs/images/external/autogen/ag2.svg docs/images/external/ag2/ag2-logo.svgdocs/images/external/autogen/ag2.svg renamed to docs/images/external/ag2/ag2-logo.svg

@@ -7,7 +7,7 @@ mode: "wide"
 ## Integrate with developer favorite agent frameworks
 
 <CardGroup cols={2}>
-  <Card title="OpenAI Agents SDK" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/openai/openai-logomark.png?raw=true" alt="OpenAI Agents SDK" />} iconType="image" href="/v1/integrations/agentssdk" />
+  <Card title="OpenAI Agents SDK" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/openai/openai-logomark.png?raw=true" alt="OpenAI Agents SDK" />} iconType="image" href="/v1/integrations/agents_sdk" />
   <Card title="CrewAI" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/v1/img/docs-icons/crew.png?raw=true" alt="CrewAI"/>} iconType="image" href="/v1/integrations/crewai" />
   <Card title="AG2" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/autogen/ag2.svg?raw=true" alt="AG2"/>} iconType="image" href="/v1/integrations/autogen" />
   <Card title="AutoGen" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/microsoft/microsoft_logo.svg?raw=true" alt="AutoGen" />} iconType="image" href="/v1/integrations/autogen" />