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

Add docs videos for OpenAI and Anthropic #597

Merged

Conversation

thaddavis
Copy link
Contributor

@thaddavis thaddavis commented Dec 21, 2024

🔍 Review Summary

Release Note

Purpose:

  • Enhance documentation with interactive and visual instructions for Anthropic and OpenAI integrations in AgentOps.

Changes:

  • Documentation:
    • Added a YouTube video to docs/v1/integrations/anthropic.mdx for Anthropic integration guidance.
    • Replaced card element with a YouTube video in docs/v1/integrations/openai.mdx for improved OpenAI integration instructions.

Impact:

  • Improved user understanding and ease of integrating AI services with AgentOps through enhanced visual documentation.
Original Description

📥 Pull Request

📘 Description
Adding YouTube docs videos to OpenAI and Anthropic integrations pages in the Mintlify docs site

https://www.youtube.com/watch?v=qlotcZSh5_0 AgentOps x OpenAI
https://www.youtube.com/watch?v=Yx2Crpbms7I AgentOps x Anthropic

🧪 Testing
Screenshots included
Screenshot 2024-12-20 at 7 51 33 PM
Screenshot 2024-12-20 at 7 48 07 PM

Copy link

Walkthrough

This update improves the documentation for Anthropic and OpenAI integrations by embedding YouTube videos. These videos provide clear, visual instructions for integrating these AI services with AgentOps, enhancing user understanding and experience.

Changes

File(s) Summary
docs/v1/integrations/anthropic.mdx Embedded a YouTube video for visual instructions on integrating Anthropic with AgentOps.
docs/v1/integrations/openai.mdx Replaced card element with an embedded YouTube video for OpenAI integration guidance.

🔗 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.

@areibman areibman merged commit ba7b2a9 into AgentOps-AI:main Dec 23, 2024
1 check passed
@areibman
Copy link
Contributor

Thanks @thaddavis !!

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.

2 participants