Skip to content

docs: Change ABC Bot link to GitHub absolute URL in getting-started RAG guide #1261

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

Merged
merged 1 commit into from
Jul 7, 2025

Conversation

bwook00
Copy link
Contributor

@bwook00 bwook00 commented Jul 3, 2025

Description

The getting-started RAG guide don't link to ABC Bot, so I kept looking for the quick example.
It's in the README under Examples, so I replaced it with an Github absolute URL:
Now we can go directly to the ABC bot example in the docs.

Checklist

  • I've read the CONTRIBUTING guidelines.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • @mentions of the person or team responsible for reviewing proposed changes.

@Pouyanpi Pouyanpi requested a review from miyoungc July 3, 2025 08:13
@Pouyanpi Pouyanpi added the documentation Improvements or additions to documentation label Jul 3, 2025
Copy link

github-actions bot commented Jul 3, 2025

Documentation preview

https://nvidia.github.io/NeMo-Guardrails/review/pr-1261

@codecov-commenter
Copy link

codecov-commenter commented Jul 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.59%. Comparing base (9cdad05) to head (20758e6).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1261      +/-   ##
===========================================
+ Coverage    69.57%   69.59%   +0.02%     
===========================================
  Files          161      161              
  Lines        16023    16029       +6     
===========================================
+ Hits         11148    11156       +8     
+ Misses        4875     4873       -2     
Flag Coverage Δ
python 69.59% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bwook00
Copy link
Contributor Author

bwook00 commented Jul 7, 2025

@miyoungc If you have time, Can you review my PR? 😀

@miyoungc
Copy link
Collaborator

miyoungc commented Jul 7, 2025

@miyoungc If you have time, Can you review my PR? 😀

@bwook00 Thank you for your contribution! Would you follow this instruction and re-push a GPG-signed commit?

@bwook00
Copy link
Contributor Author

bwook00 commented Jul 7, 2025

@miyoungc Thanks for review!
I followed the instruction and re-push!
And I got verified :)
(I accidentally did 2 commits, including a local file commit and a delete commit)

@miyoungc
Copy link
Collaborator

miyoungc commented Jul 7, 2025

@miyoungc Thanks for review! I followed the instruction and re-push! And I got verified :) (I accidentally did 2 commits, including a local file commit and a delete commit)

I'd recommend you to run git reset --soft <SHA of the commit before your first commit> and then re-do the commit to clean up the commit history with those unrelated changes.

@miyoungc
Copy link
Collaborator

miyoungc commented Jul 7, 2025

@Pouyanpi @tgasser-nv @mikemckiernan Can we get one more approval?

@bwook00
Copy link
Contributor Author

bwook00 commented Jul 7, 2025

I'd recommend you to run git reset --soft <SHA of the commit before your first commit> and then re-do the commit to clean up the commit history with those unrelated changes.

I've cleaned up the commit history.
Thank you for the kind review !

@Pouyanpi Pouyanpi added this to the v0.15.0 milestone Jul 7, 2025
@Pouyanpi Pouyanpi self-requested a review July 7, 2025 12:25
@Pouyanpi Pouyanpi merged commit 34a4e4d into NVIDIA:develop Jul 7, 2025
9 checks passed
@Pouyanpi Pouyanpi modified the milestones: v0.15.0, v0.14.1 Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants