docs: add NGXS Guru Badge for Gurubase.io (#2250) #2250

kursataktas · 2024-11-11T20:22:04Z

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

Signed-off-by: Kursat Aktas <[email protected]>

nx-cloud · 2024-11-11T20:23:22Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 148a017. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

markwhitfeld

I'm happy to add this.
@kursataktas a few questions for you:

Do any questions asked to the guru become cached permalink results? If so, for how long? It seems like I can share the link to a question that GuruBase answered and it returns the result instantly for subsequent calls to the same link.
Would it be ok to link to some gurubase answers in an FAQ section of our docs?
And lastly, how could we refresh a link if the answer should be regenerated based on the latest version of the docs?

pkg-pr-new · 2024-12-03T20:48:13Z

Open in Stackblitz

@ngxs/devtools-plugin

npm i https://pkg.pr.new/@ngxs/devtools-plugin@2250

@ngxs/form-plugin

npm i https://pkg.pr.new/@ngxs/form-plugin@2250

@ngxs/hmr-plugin

npm i https://pkg.pr.new/@ngxs/hmr-plugin@2250

@ngxs/router-plugin

npm i https://pkg.pr.new/@ngxs/router-plugin@2250

@ngxs/storage-plugin

npm i https://pkg.pr.new/@ngxs/storage-plugin@2250

@ngxs/store

npm i https://pkg.pr.new/@ngxs/store@2250

@ngxs/websocket-plugin

npm i https://pkg.pr.new/@ngxs/websocket-plugin@2250

commit: 0e8701b

bundlemon · 2024-12-03T20:51:20Z

BundleMon

Files updated (4)

Status	Path	Size	Limits
❌	fesm2022/ngxs-store-experimental.mjs	1.4KB (+862B +150.17%)	2KB / +0.5%
❌	fesm2022/ngxs-store.mjs	102.5KB (+657B +0.63%)	103KB / +0.5%
✅	fesm2022/ngxs-store-internals-testing.mjs	6.83KB (+32B +0.46%)	7KB / +0.5%
✅	fesm2022/ngxs-store-plugins.mjs	2.04KB (-349B -14.33%)	3KB / +0.5%

Unchanged files (2)

Status	Path	Size	Limits
✅	fesm2022/ngxs-store-internals.mjs	11.3KB	13KB / +0.5%
✅	fesm2022/ngxs-store-operators.mjs	6.22KB	7KB / +0.5%

Total files change +1.18KB +0.91%

Groups added (1)

Status	Path	Size	Limits
✅	@ngxs/store(esm2022)[gzip] _{./esm2022/*/.mjs}	+224.18KB	+1%

Groups updated (1)

Status	Path	Size	Limits
✅	@ngxs/store(fesm2022)[gzip] _{./fesm2022/*.mjs}	31.13KB (+116B +0.37%)	+1%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2024-12-03T20:51:22Z

BundleMon (NGXS Plugins)

Files updated (8)

Status	Path	Size	Limits
❌	Plugins(fesm2022)[gzip] _{router-plugin/fesm2022/ngxs-router-plugin.mjs}	3.19KB (+180B +5.84%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{form-plugin/fesm2022/ngxs-form-plugin.mjs}	2.59KB (+148B +5.92%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{storage-plugin/fesm2022/ngxs-storage-plugin.m js}	4.16KB (+134B +3.24%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{devtools-plugin/fesm2022/ngxs-devtools-plugin .mjs}	2.23KB (+93B +4.25%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{websocket-plugin/fesm2022/ngxs-websocket-plug in.mjs}	2.64KB (+79B +3.01%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{logger-plugin/fesm2022/ngxs-logger-plugin.mjs}	2.03KB (+28B +1.36%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{router-plugin/fesm2022/ngxs-router-plugin-int ernals.mjs}	411B (+15B +3.79%)	+0.5%
❌	Plugins(fesm2022)[gzip] _{storage-plugin/fesm2022/ngxs-storage-plugin-i nternals.mjs}	875B (+14B +1.63%)	+0.5%

Unchanged files (1)

Status	Path	Size	Limits
✅	Plugins(fesm2022)[gzip] _{hmr-plugin/fesm2022/ngxs-hmr-plugin.mjs}	2.61KB	+0.5%

Total files change +691B +3.37%

Groups updated (1)

Status	Path	Size	Limits
❌	All Plugins(fesm2022)[gzip] _{./-plugin/fesm2022/.mjs}	20.71KB (+691B +3.37%)	+0.5%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2024-12-03T20:51:24Z

BundleMon (Integration Projects)

Files updated (3)

Status	Path	Size	Limits
❌	Main bundles(Gzip) _{hello-world-ng18/dist-integration/browser/mai n-(hash).js}	71.68KB (+1.58KB +2.26%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng16/dist-integration/main.(hash) .js}	67.64KB (+345B +0.5%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng17/dist-integration/main.(hash) .js}	68.53KB (+297B +0.43%)	+1%

Total files change +2.21KB +1.07%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

kursataktas · 2024-12-10T12:26:51Z

I'm happy to add this. @kursataktas a few questions for you:

Do any questions asked to the guru become cached permalink results? If so, for how long? It seems like I can share the link to a question that GuruBase answered and it returns the result instantly for subsequent calls to the same link.

Would it be ok to link to some gurubase answers in an FAQ section of our docs?

And lastly, how could we refresh a link if the answer should be regenerated based on the latest version of the docs?

Thanks for the review, @markwhitfeld

Yes, that's correct.
Sure, I can add it as well if you can guide me.
If any data source changes, NGXS Guru regenerates answers for all cached questions. You can check the "Last Modified Date" section at the beginning of the answer to verify this. To edit data sources, you need to be a maintainer of the Guru. There is detailed information available in this repository.

codeclimate · 2024-12-10T12:30:50Z

Code Climate has analyzed commit 148a017 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 95.3% (0.0% change).

View more on Code Climate.

kursataktas · 2025-01-16T11:42:04Z

Hello @markwhitfeld,

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.

kursataktas · 2025-02-12T14:03:07Z

Hello Everyone,

I want to share an exciting update about Gurubase. We've recently released several great features that I think you'll find interesting.

1. Slack & Discord Integration

You can now add your Guru as a bot to Slack and Discord, allowing you to ask questions instantly. More details here: Discord Bot Integration.

2. Analytics Dashboard

Track what your users ask your Guru and gain valuable insights. This feature is available on the "My Gurus" page. If you haven’t maintained your Guru yet, I highly recommend doing so to access your analytics. More information about claiming your Guru can be found here.

3. API Support

All Guru functionalities are now accessible via API. You can ask questions, edit data sources, and more using our API endpoints. Here is the API Doc.

4. Codebase Indexing

We now support indexing codebases from GitHub repositories to generate answers for related queries. This feature is available for select Gurus. If you don’t see the "Codebase Indexed" label on your Guru edit page and would like access, please let me know, I’d be happy to enable it for you!

Let me know if you have any questions or feedback!

markwhitfeld · 2025-02-13T07:03:34Z

Hello @markwhitfeld,

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.

We would love this, but we use GitBook, so we are blocked until this issue is resolved:
Gurubase/gurubase-widget#7

Introducing NGXS Guru on Gurubase.io

0e8701b

Signed-off-by: Kursat Aktas <[email protected]>

kursataktas requested review from markwhitfeld, arturovt, kuncevic, Carniatto, poloagustin, joaqcid and splincode as code owners November 11, 2024 20:22

markwhitfeld approved these changes Dec 3, 2024

View reviewed changes

Merge branch 'master' into ngxs-guru

148a017

markwhitfeld approved these changes Dec 18, 2024

View reviewed changes

markwhitfeld merged commit 4499a53 into ngxs:master Dec 18, 2024
4 checks passed

markwhitfeld changed the title ~~Introducing NGXS Guru on Gurubase.io~~ docs: add NGXS Guru Badge for Gurubase.io (#2250) Dec 18, 2024

markwhitfeld mentioned this pull request Dec 18, 2024

Guru Claim Request: NGXS Gurubase/gurubase#21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add NGXS Guru Badge for Gurubase.io (#2250) #2250

docs: add NGXS Guru Badge for Gurubase.io (#2250) #2250

kursataktas commented Nov 11, 2024

nx-cloud bot commented Nov 11, 2024 •

edited

Loading

markwhitfeld left a comment

pkg-pr-new bot commented Dec 3, 2024

bundlemon bot commented Dec 3, 2024

bundlemon bot commented Dec 3, 2024

bundlemon bot commented Dec 3, 2024

kursataktas commented Dec 10, 2024

codeclimate bot commented Dec 10, 2024

kursataktas commented Jan 16, 2025

kursataktas commented Feb 12, 2025

markwhitfeld commented Feb 13, 2025

docs: add NGXS Guru Badge for Gurubase.io (#2250) #2250

docs: add NGXS Guru Badge for Gurubase.io (#2250) #2250

Conversation

kursataktas commented Nov 11, 2024

nx-cloud bot commented Nov 11, 2024 • edited Loading

☁️ Nx Cloud Report

markwhitfeld left a comment

Choose a reason for hiding this comment

pkg-pr-new bot commented Dec 3, 2024

bundlemon bot commented Dec 3, 2024

BundleMon

bundlemon bot commented Dec 3, 2024

BundleMon (NGXS Plugins)

bundlemon bot commented Dec 3, 2024

BundleMon (Integration Projects)

kursataktas commented Dec 10, 2024

codeclimate bot commented Dec 10, 2024

kursataktas commented Jan 16, 2025

kursataktas commented Feb 12, 2025

1. Slack & Discord Integration

2. Analytics Dashboard

3. API Support

4. Codebase Indexing

markwhitfeld commented Feb 13, 2025

nx-cloud bot commented Nov 11, 2024 •

edited

Loading