Skip to content

Comments

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

Merged
dot-agi merged 65 commits intomainfrom
fix/examples-cleanup
Jun 10, 2025
Merged

fix: Updated examples and relevant integrations & examples in the documentation pages#1029
dot-agi merged 65 commits intomainfrom
fix/examples-cleanup

Conversation

@dot-agi
Copy link
Member

@dot-agi dot-agi commented Jun 2, 2025

📥 Pull Request

📘 Description
Closes #1013 & #1032.

This PR overhauls and modernizes the project's examples and related documentation. It introduces new integration examples, reorganizes documentation assets, updates documentation to provide users with clearer, more comprehensive, and up-to-date guidance, provides a new script for generating documentation file from a provided notebook and enhances the GitHub action for moderating the notebooks and documentations to automatically update them.

It includes following changes:

  • Deleted the GitHub workflow for testing notebooks (.github/workflows/test-notebooks.yml).
  • Renamed docs/images/external/autogen/ag2.svg to docs/images/external/ag2/ag2-logo.svg.
  • Added a new logo for Autogen: docs/images/external/autogen/autogen-logo.svg.
  • Renamed docs/images/external/crew/crew.png to docs/images/external/crewai/crewai-logo.png.
  • Updated docs/mint.json to reflect new paths and potentially new documentation structure for integrations and examples.
  • Added new example files for AG2, Anthropic, Autogen, CrewAI, Gemini, LiteLLM, OpenAI (multi-tool RAG and Agents SDK), Watsonx, and x.AI.
  • Removed several older example files and directories.
  • Added a script generate_documentation.py in the examples directory to generate documentation file from a given notebook file.
  • Enhanced Github Action that uses Github Action Context to check for changes effectively and push out a PR for the new changes.

🧪 Testing
All notebooks are tested, the integrations are checked visually and the examples are compared against the source notebooks using the Claude Sonnet 4 LLM (good job Anthropic).

@dot-agi dot-agi self-assigned this Jun 2, 2025
@dot-agi dot-agi requested review from bboynton97 and Copilot June 4, 2025 11:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR modernizes the documentation pages with updated integration examples, new example files, and reordered asset file paths. Key changes include updated installation instructions (introducing “uv add”), improved API key setup sections, and the removal of outdated example files and workflows.

Reviewed Changes

Copilot reviewed 164 out of 164 changed files in this pull request and generated no comments.

File Description
docs/v2/integrations/*.mdx Updated integration docs with revised commands and code blocks for Anthropic, AG2, and AgentOps integration.
docs/v2/examples/*.mdx Added new examples (e.g., XAI, Watsonx, Gemini, CrewAI, Autogen, AG2 with Mem0) and removed outdated examples.
docs/mint.json Reordered page paths to mirror the new documentation structure.
.github/workflows/* Removed obsolete notebook testing workflow and updated notebook conversion workflow configuration.
Comments suppressed due to low confidence (2)

docs/v2/integrations/anthropic.mdx:19

  • Consider adding a brief inline comment or tooltip explaining the 'uv add' command for users who may be unfamiliar with this newer package manager command.
```bash uv

docs/v2/examples/openai_agents.mdx:241

  • [nitpick] It might be helpful to clarify in a comment that this simulation loop is intended solely for demonstration purposes and that interactive use may differ.
if user_input.lower() == "thanks!": # End simulation

@dot-agi dot-agi requested a review from tcdent June 9, 2025 22:06
@dot-agi dot-agi merged commit 92c621e into main Jun 10, 2025
3 checks passed
@dot-agi dot-agi deleted the fix/examples-cleanup branch June 10, 2025 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs generation script and gh action clean up examples folder

3 participants