Skip to content

docs(governance): scaffold Guardrails pages for ADP GA#7

Merged
micheleRP merged 1 commit intomainfrom
adp-guardrails-rewrite
Apr 29, 2026
Merged

docs(governance): scaffold Guardrails pages for ADP GA#7
micheleRP merged 1 commit intomainfrom
adp-guardrails-rewrite

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented Apr 28, 2026

Summary

Scaffolds the Guardrails docs surface for the ADP GA push. Beta deliverable (master Week 3, May 4–8): single concept page covering the INPUT/OUTPUT phase model, the three evaluator types (PII / Toxicity / Custom webhook), violation framing, and attachment scope — fully written and ready to ship as best-effort beta content. GA deliverables (master Weeks 4–6): four pages stubbed with full outlines and // TODO: markers keyed to specific Open Questions in the Confluence companion plan, so live walkthroughs on adp-production can resolve them in place.

  • Beta page (concept-only): governance/pages/guardrails/index.adoc — anchors on RFC 0002 Phase 5; resource-model details left as TODO markers pending team-ai's post-pivot answer (cloudv2 commits e0a1ba0cee and 7eff2ecbbf restructured the proto after the phase5-aigw-guardrails branch was cut).
  • GA stubs: create-guardrail.adoc (how-to), types-reference.adoc (per-type config schema reference), violations.adoc (read + troubleshoot violations), cost-tracking.adoc (per-evaluator cost shape + capping knobs).
  • Nav: flat governance:guardrails.adoc replaced under Trust & Governance with a Guardrails parent + 5 children (Overview / Create / Types / Violations / Cost).
  • Cleanup: deleted the 3-line governance/pages/guardrails.adoc placeholder.

Refs: DOC-2113 · Confluence plan · master plan workflow #5

Doc owner: Joyce Fee (per 2026-04-21 Confluence comment); Michele drafted this scope.

Per-page status:

Page Beta or GA State
guardrails/index.adoc Beta Drafted
guardrails/create-guardrail.adoc GA Stubbed (full outline + TODOs)
guardrails/types-reference.adoc GA Stubbed (full outline + TODOs)
guardrails/violations.adoc GA Stubbed (full outline + TODOs)
guardrails/cost-tracking.adoc GA Stubbed (full outline + TODOs)

Open Questions tracked in Confluence (26 items, grouped A–D):

  • Group A (5 items) — API surface & resource model. Block GA pages.
  • Group B (5 items) — Evaluator behavior. Needed for violations.adoc and types-reference.adoc polish.
  • Group C (5 items) — Cross-cutting integration with Transcripts, Budgets, and Governance Dashboard.
  • Group D (4 items) — Standalone-ADP wording, persona vocabulary, nav-label alignment, partial-include cleanup at GA.

Known transient-broken xref: cost-tracking.adoc cross-links to xref:governance:dashboard/index.adoc (Governance Dashboard sub-folder). That page is being added in adp-docs PR #5 and resolves once #5 merges. Same pattern as Budgets PR #6.

Out of scope (separate workstreams):

Preview pages

Test plan

  • Confirm Trust & Governance nav renders the Guardrails sub-section with 5 children
  • Walk the Overview page cold and confirm a first-time reader can answer: what a guardrail is, the three evaluator types, where violations show up
  • Confirm the four GA stubs render with their TODO outlines visible
  • (Master Week 2 pre-flight) Ping team-ai for the post-pivot Guardrail resource shape so GA-page drafting can begin in master Week 3
  • (Master Weeks 4–6) Walk live aigwctl guardrail flow (or ADP UI if it ships) to fill TODO markers
  • Watch for adp-docs PR docs(governance): add Governance Dashboard pages for ADP GA #5 to merge so the dashboard cross-link resolves
  • (Master Weeks 7–8) Editorial pass via docs-team-standards:review; remove adp-la.adoc partial includes at GA

🤖 Generated with Claude Code

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 28, 2026

Deploy Preview for redpanda-agentic-data-plane ready!

Name Link
🔨 Latest commit f8fbb89
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/69f21aaac6043600075e6283
😎 Deploy Preview https://deploy-preview-7--redpanda-agentic-data-plane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@micheleRP micheleRP marked this pull request as ready for review April 29, 2026 01:17
@micheleRP micheleRP requested a review from a team as a code owner April 29, 2026 01:17
Beta deliverable (master Week 3, May 4-8): single concept page
covering INPUT/OUTPUT phase model, the three evaluator types
(PII / Toxicity / Custom webhook), violation framing, and
attachment scope. Anchors on RFC 0002 Phase 5; resource-model
details left as TODO markers pending team-ai's post-pivot answer.

GA deliverables (master Weeks 4-6): four pages stubbed with
full outlines and TODO markers keyed to specific Open Questions
in the Confluence companion plan, so live walkthroughs on
adp-production can resolve them in place:

- create-guardrail.adoc — how-to for configuring + attaching
- types-reference.adoc — config schema reference per evaluator
- violations.adoc — read & troubleshoot violations
- cost-tracking.adoc — per-evaluator cost shape + capping

Nav: replaces the flat governance:guardrails.adoc placeholder
under Trust & Governance with a Guardrails parent + 5 children.
The 3-line governance/pages/guardrails.adoc placeholder is
deleted in this commit.

Cross-link to governance:dashboard/index.adoc is transient-broken
until adp-docs PR #5 (Governance Dashboard) merges; same pattern
as Budgets PR #6.

Refs: DOC-2113. Plan:
https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1881702438

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

# Conflicts:
#	modules/ROOT/nav.adoc
@micheleRP micheleRP force-pushed the adp-guardrails-rewrite branch from e964e16 to f8fbb89 Compare April 29, 2026 14:50
@micheleRP micheleRP merged commit 4f1bb18 into main Apr 29, 2026
3 of 4 checks passed
@micheleRP micheleRP deleted the adp-guardrails-rewrite branch April 29, 2026 14:50
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