Skip to content

Conversation

kursataktas
Copy link
Contributor

Hello team,

I'm the maintainer of Anteon. We have created Gurubase.io with the mission of building a centralized, open-source tool-focused knowledge base. Essentially, each "guru" is equipped with custom knowledge to answer user questions based on collected data related to that tool.

I wanted to update you that I've manually added the Ocelot Guru to Gurubase. Ocelot Guru uses the data from this repo and data from the docs to answer questions by leveraging the LLM.

In this PR, I showcased the "Ocelot Guru", which highlights that Ocelot now has an AI assistant available to help users with their questions. Please let me know your thoughts on this contribution.

Additionally, if you want me to disable Ocelot Guru in Gurubase, just let me know that's totally fine.

Copy link
Member

@raman-m raman-m left a comment

Choose a reason for hiding this comment

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

Dear Kursat,

First,

Could you inform me whether your team's product is free and open-source?

Second,

I wanted to update you that I've manually added the Ocelot Guru to Gurubase.

Good!

Ocelot Guru uses the data from this repo and data from the docs to answer questions by leveraging the LLM.

If the LLM is directed to read the official HTML documentation from Read the Docs, that's acceptable. However, our repository's Discussions also contain valuable and official answers amidst some less useful content.
Are there plans to direct the LLM to additionally read the Discussions?

Comment on lines +66 to +67
- [Ask Ocelot Guru](https://gurubase.io/g/ocelot)
<br/>It's a Ocelot-focused AI to answer your questions.
Copy link
Member

@raman-m raman-m Nov 14, 2024

Choose a reason for hiding this comment

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

Laughing out loud, I'm in tears! 🤣

The upcoming essential AI IO-helper for our junior Ocelot enthusiasts is a must-see.

I need input from the team: @RaynaldM @ggnaegi, what are your views on AI fun?
I've posed a rather abstract question: "What's the difference between Ocelot and YARP?"
The response seems acceptable to me despite a few inaccuracies, suggesting that the AI might be reading the sources and blending them with enhancements in presentation. Overall, the answer is fairly good.

@raman-m raman-m added proposal Proposal for a new functionality in Ocelot documentation Needs a documentation update labels Nov 14, 2024
@kursataktas
Copy link
Contributor Author

Dear Kursat,

First,

Could you inform me whether your team's product is free and open-source?

Second,

I wanted to update you that I've manually added the Ocelot Guru to Gurubase.

Good!

Ocelot Guru uses the data from this repo and data from the docs to answer questions by leveraging the LLM.

If the LLM is directed to read the official HTML documentation from Read the Docs, that's acceptable. However, our repository's Discussions also contain valuable and official answers amidst some less useful content. Are there plans to direct the LLM to additionally read the Discussions?

Thanks for the review.

  • As of today, Gurubase is not an open-source project, but it is also not commercial.
  • Ocelot Guru generates answers based on the official docs and the README. We have plans to use GitHub issues and discussions, but it is still in the idea stage.

@raman-m
Copy link
Member

raman-m commented Nov 19, 2024

As of today, Gurubase is not an open-source project, but it is also not commercial.

However, you are planning to commercialize it, correct? I would prefer to make the PR draft until your final business decision is made. As an OSS product, Ocelot can have refs to open-source libraries and products. We review products that have an OSS version; it appears acceptable for the product to be commercial as long as it has an OSS plan.

Currently, we are facing issue with old IdentityServer4 reference, has critical vulnerabilities associated with Ocelot on GitHub. However, the previous development team suggested migrating to the next IdentityServer product that offers an open-source software plan from the @DuendeSoftware organization. Since Ocelot does not have direct dependencies on this library, the migration work is ongoing and is not considered critical, as we only utilize IdentityServer4 references in our testing projects.

@raman-m raman-m marked this pull request as draft November 19, 2024 14:17
@kursataktas
Copy link
Contributor Author

I can't provide promises for the future of course, but even if we convert it to a commercial product, I strongly believe that charging open-source projects wouldn't be a good pricing strategy.

@raman-m raman-m marked this pull request as ready for review November 25, 2024 13:09
@raman-m raman-m self-assigned this Nov 25, 2024
@raman-m raman-m added this to the .NET 9 milestone Nov 25, 2024
@raman-m
Copy link
Member

raman-m commented Nov 25, 2024

Ready for Review

...due to the merging of README.md file, which will be updated in the .NET 9 milestone.

@raman-m
Copy link
Member

raman-m commented Dec 10, 2024

Approved by @RaynaldM

@raman-m raman-m merged commit 29c72f8 into ThreeMammals:develop Dec 10, 2024
1 check passed
@kursataktas
Copy link
Contributor Author

Hello @raman-m,

We recently released the embeddable "Ask AI" widget, which allows you to integrate your Guru’s Q&A capability into websites, documentation, and more.

The installation process is straightforward, as explained in this GitHub repository.

You can see it in action on the Anteon and NetAlertX websites.

@raman-m
Copy link
Member

raman-m commented Jan 17, 2025

@kursataktas Thanks! Good to know! Very nice widget...
However, I am unsure how to utilize the widget in Ocelot, as our project is purely backend. Perhaps it could be implemented as a custom widget in Read the Docs documentation? However, this would require front-end development...

@kursataktas
Copy link
Contributor Author

@kursataktas Thanks! Good to know! Very nice widget... However, I am unsure how to utilize the widget in Ocelot, as our project is purely backend. Perhaps it could be implemented as a custom widget in Read the Docs documentation? However, this would require front-end development...

I can add it to the documentation website and open a PR if you’d like. How does that sound?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Needs a documentation update proposal Proposal for a new functionality in Ocelot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants