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

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

Merged
merged 2 commits into from
Dec 18, 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 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.

Copy link

nx-cloud bot commented Nov 11, 2024

☁️ 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.

Copy link
Member

@markwhitfeld markwhitfeld left a comment

Choose a reason for hiding this comment

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

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

  1. 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.
  2. Would it be ok to link to some gurubase answers in an FAQ section of our docs?
  3. And lastly, how could we refresh a link if the answer should be regenerated based on the latest version of the docs?

Copy link

pkg-pr-new bot commented Dec 3, 2024

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

Copy link

bundlemon bot commented Dec 3, 2024

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

Copy link

bundlemon bot commented Dec 3, 2024

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

Copy link

bundlemon bot commented Dec 3, 2024

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
Copy link
Contributor Author

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

  1. 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.
  2. Would it be ok to link to some gurubase answers in an FAQ section of our docs?
  3. 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

  1. Yes, that's correct.
  2. Sure, I can add it as well if you can guide me.
  3. 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.

Copy link

codeclimate bot commented Dec 10, 2024

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.

@markwhitfeld markwhitfeld merged commit 4499a53 into ngxs:master Dec 18, 2024
4 checks passed
@markwhitfeld markwhitfeld changed the title Introducing NGXS Guru on Gurubase.io docs: add NGXS Guru Badge for Gurubase.io (#2250) Dec 18, 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.

2 participants