Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Action - Update examples in docs from notebooks #584

Closed
wants to merge 1 commit into from

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Dec 16, 2024

🔍 Review Summary

Purpose

Update documentation examples to align with the latest notebook versions.

Key Changes

  • Enhancement:
    • Langchain documentation expanded with comprehensive code snippets and setup instructions for using AgentOps.
    • Multion documentation image source link updated to reflect the latest version of the multion_integration.png file.
    • Parameter name changed from params to logs in the simple_agent.mdx file for clarity and consistency.

Impact

Provides users with up-to-date and detailed documentation examples for seamless integration and usage of the notebook versions, improving overall user experience.

Original Description

No existing description found

@github-actions github-actions bot force-pushed the update-examples-in-docs-from-notebooks branch from 7e1e6b4 to 6d571d4 Compare December 16, 2024 08:24
Copy link

Walkthrough

The pull request focuses on enhancing documentation examples to align with the latest notebook versions. Key updates include:

  1. Langchain Documentation: The langchain.mdx file has been significantly expanded with comprehensive code snippets and explanations for using AgentOps, covering both synchronous and asynchronous agent examples. Additional setup instructions, API key usage, and callback handler integration details have been included.

  2. Multion Documentation: The multion.mdx file has been updated to correct the image source link, ensuring it reflects the latest version of the multion_integration.png file.

  3. Simple Agent Documentation: A minor but important change was made in the simple_agent.mdx file, where a parameter name was changed from params to logs in the ActionEvent function call to enhance clarity and consistency across the documentation.

Changes

File(s) Summary
docs/v1/examples/langchain.mdx Expanded with detailed code snippets for AgentOps with Langchain, including synchronous and asynchronous examples, setup instructions, API key usage, and callback handler integration.
docs/v1/examples/multion.mdx Updated image source link to the latest version of multion_integration.png.
docs/v1/examples/simple_agent.mdx Renamed parameter from params to logs in ActionEvent function for clarity.

🔗 Related PRs

Instructions

Emoji Descriptions:

  • ⚠️ Potential Issue - May require further investigation.
  • 🔒 Security Vulnerability - Fix to ensure system safety.
  • 💻 Code Improvement - Suggestions to enhance code quality.
  • 🔨 Refactor Suggestion - Recommendations for restructuring code.
  • ℹ️ Others - General comments and information.

Interact with the Bot:

  • Send a message or request using the format:
    @bot + *your message*
Example: @bot Can you suggest improvements for this code?
  • Help the Bot learn by providing feedback on its responses.
    @bot + *feedback*
Example: @bot Do not comment on `save_auth` function !

Execute a command using the format:

@bot + */command*

Example: @bot /updateCommit

Available Commands:

  • /updateCommit ✨: Apply the suggested changes and commit them (or Click on the Github Action button to apply the changes !)
  • /updateGuideline 🛠️: Modify an existing guideline.
  • /addGuideline ➕: Introduce a new guideline.

Tips for Using @bot Effectively:

  • Specific Queries: For the best results, be specific with your requests.
    🔍 Example: @bot summarize the changes in this PR.
  • Focused Discussions: Tag @bot directly on specific code lines or files for detailed feedback.
    📑 Example: @bot review this line of code.
  • Managing Reviews: Use review comments for targeted discussions on code snippets, and PR comments for broader queries about the entire PR.
    💬 Example: @bot comment on the entire PR.

Need More Help?

📚 Visit our documentation for detailed guides on using Entelligence.AI.
🌐 Join our community to connect with others, request features, and share feedback.
🔔 Follow us for updates on new features and improvements.

@the-praxs
Copy link
Member

Fixed issues triggering this action in #585

@the-praxs the-praxs closed this Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants