NVIDIA-NeMo / NVIDIA-NeMo/Guardrails

doc: sequence diagram image asset is missing/broken

Open Beginner friendly
#2,346 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation status: needs triage
Dominant language
Python
Stars
7.2k
Forks
842
Avg merge
3d 1h
Merged PRs (30d)
25

Description

Please also confirm the following
  • I have searched the main issue tracker of NeMo Guardrails repository and believe that this is not a duplicate
Issue Kind

Improving documentation

Existing Link

https://docs.nvidia.com/nemo/guardrails/reference/guardrails-sequence-diagrams

Description
Summary

The sequence diagram on the Guardrails Sequence Diagrams documentation page is missing or failing to load. Instead of rendering the visual diagram, the page only displays the raw alt fallback text.

Affected Page
  • URL: https://docs.nvidia.com/nemo/guardrails/reference/guardrails-sequence-diagrams
Steps to Reproduce
  1. Navigate to the Guardrails Sequence Diagrams documentation page.
  2. Scroll to the section under "The following diagram depicts the guardrails process in detail:".
Expected Behavior

A rendered sequence diagram image/graphic illustrating the complete NeMo Guardrails lifecycle (Input Validation, Dialog, and Output Validation stages).

Actual Behavior

The image asset does not load, and the text block description of the diagram (Sequence diagram showing the complete guardrails process in NeMo Guardrails...) is displayed directly on the page instead.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Guardrails Sequence Diagrams page at the provided URL and inspect the documentation source for the broken sequence-diagram reference. Confirm the asset path and rendering behavior, then verify that the page displays the complete lifecycle diagram instead of its alt text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.