Skip to content

Conversation

@miyoungc
Copy link
Collaborator

@miyoungc miyoungc commented Dec 19, 2025

Description

  • Improved the get started pages. Most of the content change are:
    • The installation page cleanup
    • Unify the shape of each tutorial by adding missing sections: prerequisites, verify guardrails, etc.
    • Generate a new Configuration Reference page based on the source code nemoguardrails/rails/llm/config.py and update the code samples.
  • Added various AI-generated diagrams in mermaid and draw.io to resources.
  • The rest are frontmatter refresh, and align the grid cards and the left nav titles with frontmatter.

Related Issue(s)

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.

@miyoungc miyoungc self-assigned this Dec 19, 2025
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Dec 19, 2025
@github-actions
Copy link
Contributor

Documentation preview

https://nvidia-nemo.github.io/Guardrails/review/pr-1554

@codecov
Copy link

codecov bot commented Dec 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@miyoungc miyoungc changed the title docs: update get started and some frontmatter updates docs: update top pages, add use case diagrams, refresh frontmatter and align with cards and nav Dec 20, 2025
@miyoungc miyoungc merged commit 50cd525 into develop Jan 6, 2026
10 checks passed
@miyoungc miyoungc deleted the miyoungc/update-top-pages branch January 6, 2026 00:30
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.

3 participants