fix: Updated examples and relevant integrations & examples in the documentation pages#1029
Merged
fix: Updated examples and relevant integrations & examples in the documentation pages#1029
Conversation
…exponential growth."
Contributor
There was a problem hiding this comment.
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
tcdent
approved these changes
Jun 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📥 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:
.github/workflows/test-notebooks.yml).docs/images/external/autogen/ag2.svgtodocs/images/external/ag2/ag2-logo.svg.docs/images/external/autogen/autogen-logo.svg.docs/images/external/crew/crew.pngtodocs/images/external/crewai/crewai-logo.png.docs/mint.jsonto reflect new paths and potentially new documentation structure for integrations and examples.generate_documentation.pyin theexamplesdirectory to generate documentation file from a given notebook file.🧪 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).