docs: rewrite guardrails for the Bedrock-backed feature#63
Merged
Conversation
The guardrails pages described a PII/Toxicity/Custom-webhook model with a violations UI that never shipped. Rewrite all four pages to match what ships, verified against guardrail.proto on cloudv2 origin/main and the ADP UI: - overview: reframe around the six Bedrock policies (content filters, word filters, denied topics, sensitive information, contextual grounding, automated reasoning), the AWS Bedrock requirement, input/ output evaluation with the streaming-output caveat, provider binding, and how blocked requests surface. - create-guardrail: rewrite to the three-step wizard (Details, Backend, Policies) with the per-policy 'Evaluate this policy' staging toggle, credential source/type, provider attachment, and edit/disable/delete. - types-reference -> 'Guardrail Policy Reference': full per-policy schemas (categories, strengths, actions, PII entity types, regex, topics, grounding thresholds, automated-reasoning versioned ARNs). - violations: reframe to how a blocked request surfaces (blocked message, anonymize, OTel trace/transcript); drop the violations-table, metrics, and fail-open/closed claims that do not ship. - budgets: correct the guardrail-cost section (guardrail usage is billed by AWS Bedrock, not tracked in ADP spend) and fix stale link text. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The roadmap TODO listed configurable caps and per-agent caps as not yet shipped, which contradicts the page body (both ship). Align it with the NOTE on the page: only shared pools, model/provider/org-scoped limits, and notification delivery remain unshipped. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Remove step numbers from create-guardrail headings (style rule).
- Spell out RAG and ARN on first use; drop 'should'.
- Standardize the violations learning-objective lead-in.
- Link the transcript glossterm on first mention.
- Prefer active voice in guardrail/budget descriptions.
- Trim the overview description under 155 characters and rename the
policy-types heading.
- Drop the hardcoded policy count ('six') so it can't go stale.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The guardrails docs described a feature that doesn't ship: PII / Toxicity / Custom-webhook evaluators, a global INPUT/OUTPUT/BOTH phase selector, attach-in-create, and a violations UI. This rewrites all four pages to match what actually ships, verified against
guardrail.protoon cloudv2origin/mainplus the ADP/guardrailsUI.What ships (and is now documented)
ApplyGuardrail).Pages
guardrails/overview.adoc— reframed around the six policies, Bedrock requirement, evaluation model, binding, and blocking behavior.guardrails/create-guardrail.adoc— rewritten to the 3-step wizard with real fields.guardrails/types-reference.adoc— retitled Guardrail Policy Reference; full per-policy schemas. Nav + index updated.guardrails/violations.adoc— reframed/trimmed to how a blocked request surfaces.budgets.adoc— corrected the guardrail-cost section (guardrail usage is billed by AWS Bedrock, not tracked in ADP spend) and fixed stale link text.Preview
🤖 Generated with Claude Code