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

bug: hyperlink not rendered in guardrails library documentation #804

Open
3 of 4 tasks
AshishSardana opened this issue Oct 15, 2024 · 4 comments
Open
3 of 4 tasks
Labels
bug Something isn't working

Comments

@AshishSardana
Copy link
Contributor

Did you check docs and existing issues?

  • I have read all the NeMo-Guardrails docs
  • I have updated the package to the latest version before submitting this issue
  • (optional) I have used the develop branch
  • I have searched the existing issues of NeMo-Guardrails

Python version (python --version)

3.10

Operating system/version

MacOS 14

NeMo-Guardrails version (if you must use a specific version and not the latest

No response

Describe the bug

The documentation of guardrails library is updated but the hyperlink to Cleanlab's Integration Guide is not working.

The source code (in markdown) seems to be correct i.e. the hyperlink/reference to the file works when clicked from the md here.

Steps To Reproduce

  1. Go to https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#cleanlab
  2. Try to click on "Cleanlab Integration page".
  3. Now, go to the source code at https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/docs/user_guides/guardrails-library.md#cleanlab
  4. Again click on "Cleanlab Integration page".

Expected Behavior

The hyperlink to Cleanlab Integration page should work from the documentation webpage.

Actual Behavior

Attached snippet of documentation's webpage where the "Cleanlab Integration page" hyperlink doesn't work

Image
Image

@AshishSardana AshishSardana added the bug Something isn't working label Oct 15, 2024
@paveeshbr
Copy link

I have tried to reproduce this in my local. It is rendering the Cleanlab Integration link.
Image

@AshishSardana
Copy link
Contributor Author

@paveeshbr It's rendering properly in the markdown file i.e. the source code seems correct but the documentation webpage (linked above) doesn't have the hyperlink (as is seen in the screenshot and on the web page itself)

@Pouyanpi
Copy link
Collaborator

Hi @AshishSardana, thanks for reporting this issue. We will have it fixed soon.

@AshishSardana
Copy link
Contributor Author

hey @Pouyanpi, congratulations on the v0.11.0 release! since this issue persists in the new release, i am wondering if there's something i can work on to fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants