Skip to content

LCORE-3394: Granite Guardian Shield Docs - #2637

Draft
jrobertboos wants to merge 1 commit into
lightspeed-core:mainfrom
jrobertboos:lcore-3394
Draft

LCORE-3394: Granite Guardian Shield Docs#2637
jrobertboos wants to merge 1 commit into
lightspeed-core:mainfrom
jrobertboos:lcore-3394

Conversation

@jrobertboos

Copy link
Copy Markdown
Contributor

Description

Adds user-facing documentation for the granite_guardian shield type (IBM Granite Guardian moderation guardrail), which was previously only defined in the Pydantic config models (GraniteGuardianConfig, GraniteGuardianShieldConfiguration, RiskDefinition) without any corresponding docs.

Changes:

  • docs/user_doc/shields_guide.md: Added a granite_guardian section alongside the existing question_validity and redaction sections, following the same Config field | Required | Description table format. Includes a note that the runtime capability is not yet wired (config is validated at startup, but moderation is not yet invoked).
  • docs/user_doc/config.md: Added schema tables for GraniteGuardianConfig, GraniteGuardianShieldConfiguration, and RiskDefinition, and updated the top-level shields field description to mention Granite Guardian.
  • examples/lightspeed-stack-shields.yaml: Added a product-guardian shield example (provider_id: granite_guardian) with two sample risks (roleplay-jailbreak on input, harm-output on output), demonstrating the required/optional config fields.
  • docs/index.md: Added a "Safety shields" link to the docs landing page (was previously missing).

This is a documentation-only change; no application code or config schema was modified — the granite_guardian shield type already existed in src/models/config.py.

Type of change

  • Documentation Update
  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: Cursor (Claude Sonnet 5)
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue LCORE-3394

Checklist before requesting a review

  • I have performed a self-review of my code.
  • PR has passed all pre-merge test jobs.
  • If it is a core feature, I have added thorough tests.

Testing

Manually reviewed the rendered Markdown (shields_guide.md, config.md) and the example YAML for correctness, and checked that the new granite_guardian section/tables are consistent in structure and tone with the existing question_validity and redaction sections. No code paths changed, so no unit/integration tests were added or run.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant