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

Introducing Orchard Core Guru on Gurubase.io #17001

Merged
merged 6 commits into from
Nov 16, 2024

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 Orchard Core Guru to Gurubase. Orchard Core 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 "Orchard Core Guru", which highlights that Orchard Core 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 Orchard Core Guru in Gurubase, just let me know that's totally fine.

Copy link
Contributor

Thank you for submitting your first pull request, awesome! 🚀 If you haven't already, please take a moment to review our contribution guide. This guide provides helpful information to ensure your contribution aligns with our standards. A core team member will review your pull request.

If you like Orchard Core, please star our repo and join our community channels.

@MikeAlhayek
Copy link
Member

@kursataktas Thank you! Please agree to the Contributor License Agreement(CLA)

@kursataktas
Copy link
Contributor Author

@dotnet-policy-service agree

README.md Outdated Show resolved Hide resolved
Copy link
Member

@Piedone Piedone left a comment

Choose a reason for hiding this comment

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

Ah, very cool! A couple of things:

  1. Could you link it from the tutorials page too? See https://docs.orchardcore.net/en/latest/guides/contributing/contributing-documentation/.
  2. How about including these too in the training data?
  1. This is just +1: Can't you allow follow-up questions? Currently, you ask a question, you get an answer, but if that's not perfect, your only option is to try to ask a new, better question.

See this @sfmskywalker.

@sfmskywalker
Copy link
Member

This sounds super interesting. I’ve been wanting to replace Glime since they shutdown, and this might be a viable alternative. Thanks for the tip!

@sfmskywalker
Copy link
Member

@kursataktas are there any procedures one might follow to get another OSS project added. Maybe something like https://github.com/elsa-workflows/elsa-core?

@kursataktas
Copy link
Contributor Author

Ah, very cool! A couple of things:

  1. Could you link it from the tutorials page too? See https://docs.orchardcore.net/en/latest/guides/contributing/contributing-documentation/.
  2. How about including these too in the training data?
  1. This is just +1: Can't you allow follow-up questions? Currently, you ask a question, you get an answer, but if that's not perfect, your only option is to try to ask a new, better question.

See this @sfmskywalker.

Thanks for the review ❤️

  1. I've updated the PR accordingly. Let me know if you’d like any changes to the text.
  2. Sure, I can do that. Gurubase indexes text-based and video files, so documentation and GitHub READMEs are fine. However, we haven’t tested the raw code files, so I don’t recommend including them. I can add the README files from these repositories if you’d like.

Additionally, I found some helpful blog posts on https://orcharddojo.net/ that I can add as a datasource for Orchard Code Guru. However, some of them might be outdated, which could lead to incorrect answers. Is there a time threshold to discard old blog posts, or should I include all of them? Your guidance on this would be helpful.

https://orcharddojo.net/blog/4-ways-to-display-something-from-your-module-nested-within-a-page-in-orchard-core-orchard-nuggets
https://orcharddojo.net/blog/add-deployment-for-microsoft-account-deprecate-site-owner-permission-and-retain-administrator-role-as-a-system-role-this-week-in-orchard-01-11-2024
https://orcharddojo.net/blog/add-title-to-background-tasks-and-improve-the-ui-lombiq-node-js-extensions-this-week-in-orchard-17-02-2023
https://orcharddojo.net/blog/advanced-orchard-accessing-other-tenants-services
https://orcharddojo.net/blog/another-lombiq-site-was-improved-orchard-dojo
https://orcharddojo.net/blog/basic-orchard-course-at-obuda-university
https://orcharddojo.net/blog/blazor-guide-for-decoupled-cms-workflow-trimming-task-this-week-in-orchard-06-09-2024
https://orcharddojo.net/blog/content-item-and-widget-alternates-based-on-the-alias-and-slug-url-rewriting-module-this-week-in-orchard-25-10-2024
https://orcharddojo.net/blog/delivering-a-node-js-asset-pipeline-as-a-nuget-package
https://orcharddojo.net/blog/don-t-configure-jsonoptions-by-default-orchard-harvest-2024-videos-are-up-this-week-in-orchard-08-11-2024
https://orcharddojo.net/blog/external-authentication-feature-orchard-nuggets-how-to-add-workflows-to-an-asp-net-core-app-this-week-in-orchard-18-10-2024
https://orcharddojo.net/blog/how-can-i-call-an-external-api-from-a-workflow-task-orchard-nuggets
https://orcharddojo.net/blog/how-to-access-services-from-another-tenant-in-orchard-core-orchard-nuggets
https://orcharddojo.net/blog/how-to-add-a-breadcrumb-menu-in-orchard-core-orchard-nuggets
https://orcharddojo.net/blog/how-to-add-a-culture-url-segment-for-localization-in-orchard-core-orchard-nuggets
https://orcharddojo.net/blog/how-to-add-an-audit-trail-to-an-asp-net-core-app-orchard-core-nuggets
https://orcharddojo.net/blog/how-to-add-workflows-to-an-asp-net-core-app-orchard-core-nuggets
https://orcharddojo.net/blog/how-to-change-the-idle-logout-time-in-orchard-core-orchard-core-nuggets
https://orcharddojo.net/blog/how-to-debug-a-nuget-based-orchard-core-solution-orchard-nuggets
https://orcharddojo.net/blog/how-to-do-a-security-scan-of-an-orchard-core-app-orchard-core-nuggets
https://orcharddojo.net/blog/how-to-fix-invaliddataexception-form-value-count-limit-1024-exceeded-in-orchard-core-orchard-nuggets
https://orcharddojo.net/blog/how-to-localize-content-items-orchard-nuggets
https://orcharddojo.net/blog/how-to-migrate-an-orchard-1-application-to-orchard-core
https://orcharddojo.net/blog/intensive-orchard-core-training-for-the-in-motion-team
https://orcharddojo.net/blog/live-from-orchard-harvest-2024-las-vegas-day-2
https://orcharddojo.net/blog/one-week-intensive-orchard-training-for-the-national-institute-for-clinical-excellence-in-manchester
https://orcharddojo.net/blog/open-dojo-course-and-university-orchard-course
https://orcharddojo.net/blog/orchard-cms-tutorial-recipes-in-orchard-cms
https://orcharddojo.net/blog/orchard-core-2-0-orchard-harvest-2024-this-week-in-orchard-11-10-2024
https://orcharddojo.net/blog/orchard-core-2-0-orchard-harvest-2024-this-week-in-orchard-20-09-2024
https://orcharddojo.net/blog/orchard-core-gallery-orchard-core-2-0-2-this-week-in-orchard-04-10-2024
https://orcharddojo.net/blog/orchard-core-workshops
https://orcharddojo.net/blog/orchard-harvest-2024-montage-video-orchard-dojo-case-study-this-week-in-orchard-27-09-2024
https://orcharddojo.net/blog/our-full-orchard-core-tutorial-series-the-dojo-course-3-is-here
https://orcharddojo.net/blog/training-the-microsoft-mcio-team-on-how-to-develop-orchard
  1. We are currently developing the follow-up feature, and I believe it will be available in a few weeks. I highly recommend joining our Discord channel and following our Twitter account to stay updated on new features.

@Piedone
Copy link
Member

Piedone commented Nov 16, 2024

  1. Thanks! Changed it a bit, and will merge it once the checks pass.
  2. Ah I see, so Gurubase is not processing code. Adding that would be probably the biggest jump, I think, because for OSS projects usually the documentation is not complete. However, the codebase will likely contain all the information you need to work with the project (well, the actual implementation is there, of course, but it'll also have samples and tests that demonstrate usage in an up-to-date fashion).
    There's a cutoff, yes, anything before 2020 is likely outdated. From your list, these are not applicable today (for Orchard Core, the latest edition of Orchard):
  1. Great! I've joined your Discord.

@Piedone Piedone merged commit 471b5d7 into OrchardCMS:main Nov 16, 2024
12 checks passed
Copy link
Contributor

Congratulations on your first PR merge! 🎉 Thank you for your contribution! We're looking forward to welcoming other contributions of yours in the future. @all-contributors please add @kursataktas for code.

If you like Orchard Core, please star our repo and join our community channels.

@Piedone
Copy link
Member

Piedone commented Nov 16, 2024

@all-contributors please add @kursataktas for documentation.

Copy link
Contributor

@Piedone

I've updated the pull request to add @kursataktas! 🎉

@kursataktas
Copy link
Contributor Author

There's a cutoff, yes, anything before 2020 is likely outdated. From your list, these are not applicable today (for Orchard Core, the latest edition of Orchard):

I added these blogs as data source for Orchard Guru by eliminating the old ones according to your comment. 🎊

I also responded to the other topics on Discord, fyi.

@Piedone
Copy link
Member

Piedone commented Nov 18, 2024

Great, thank you!

@kursataktas
Copy link
Contributor Author

Hi everyone,

I’d like to update you on the release of the Maintainer Panel feature on Gurubase. With this panel, you can add, remove, or update data sources, as well as change the logo and more. You can find the details here.

In the near future, I’m planning to include analytics insights in this panel, such as the number of questions asked, the most frequently asked ones, and more. I’ll be sure to update this thread once it’s available. However, in case I miss it, I highly recommend joining our Discord channel to stay updated.

If you’d prefer that I don’t update this thread anymore, please let me know.

@Piedone
Copy link
Member

Piedone commented Nov 26, 2024

Does that mean we can add the codebase as a source too?

Having updates under this PR is nice, though I don't think many people apart from those who commented here will see it. For that, https://github.com/OrchardCMS/OrchardCore/discussions is better.

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