docs: frontmatter updates and content type labels to grid cards

[miyoungc]

Description

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.

[github-actions]

Documentation preview

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

[greptile-apps]

Greptile Overview

Greptile Summary

This PR updates documentation frontmatter across 67 files to align with a new Diataxis-based content type taxonomy and adds content type labels to grid cards throughout the documentation.

Key changes:

• Standardized frontmatter fields (title, description, keywords, topics, tags, content.type, content.difficulty, content.audience) with proper YAML list formatting
• Added content type badges ({bdg-secondary}) to grid cards with labels like "How To", "Tutorial", "Reference", "Concept", and "Get Started"
• Renamed docs/evaluation/README.md to evaluate-guardrails.md with updated frontmatter
• Deleted orphaned RST files (docs/evaluation/index.rst, docs/observability/logging/index.rst)
• Updated toctree references to match renamed files

Issues found:

• Inconsistent audience field values in 3 files - some use space-separated names with capitals (AI Engineer, DevOps Engineer, AI Researcher) while the majority use snake_case (engineer, data_scientist, ai_engineer)

Confidence Score: 4/5

• This PR is safe to merge with minor style inconsistencies
• The changes are purely documentation updates with consistent patterns across files. The only issues are minor style inconsistencies in audience field naming conventions in 3 files, which don't affect functionality
• Review audience field formatting in docs/evaluation/evaluate-guardrails.md, docs/getting-started/tutorials/index.md, and docs/deployment/index.md for naming consistency

Important Files Changed

Filename	Overview
docs/evaluation/evaluate-guardrails.md	Renamed from README.md and updated frontmatter; has inconsistent audience field values with spaces in names
docs/getting-started/tutorials/index.md	Updated frontmatter and added content type badges to grid cards; has inconsistent audience field with 'AI Engineer'
docs/deployment/index.md	Updated frontmatter and added badges; has inconsistent audience values with spaces
docs/configure-rails/actions/index.md	Updated frontmatter with proper YAML list format and added content type badges to all grid cards
docs/index.md	Added content type badges to grid cards and updated toctree references

Sequence Diagram

sequenceDiagram
    participant Author
    participant DocFiles as Documentation Files
    participant Frontmatter as YAML Frontmatter
    participant GridCards as Grid Cards
    participant Build as Doc Build System
    
    Author->>DocFiles: Update 67 documentation files
    Author->>Frontmatter: Standardize frontmatter fields
    Frontmatter->>Frontmatter: Convert to YAML list format
    Frontmatter->>Frontmatter: Update content.type values
    Frontmatter->>Frontmatter: Update content.difficulty values
    Frontmatter->>Frontmatter: Update content.audience values
    Author->>GridCards: Add content type badges
    GridCards->>GridCards: Add {bdg-secondary} labels
    GridCards->>GridCards: Labels: How To, Tutorial, Reference, etc.
    Author->>DocFiles: Rename evaluation/README.md
    DocFiles->>DocFiles: Now: evaluate-guardrails.md
    Author->>DocFiles: Delete orphaned RST files
    DocFiles->>DocFiles: Remove index.rst files
    Author->>DocFiles: Update toctree references
    DocFiles->>Build: Ready for documentation build
    Build->>Build: Process updated frontmatter
    Build->>Build: Render content type badges

Loading

[greptile-apps]

_{3 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!