Skip to content

Add SDK PII redaction docs to zeroeval-docs#5

Merged
sebastiancrossa merged 1 commit intomainfrom
capy/add-pii-redaction-docs
Apr 9, 2026
Merged

Add SDK PII redaction docs to zeroeval-docs#5
sebastiancrossa merged 1 commit intomainfrom
capy/add-pii-redaction-docs

Conversation

@sebastiancrossa
Copy link
Copy Markdown
Member

@sebastiancrossa sebastiancrossa commented Apr 9, 2026

Adds SDK-side PII redaction documentation pages for Python and TypeScript tracing SDKs.

  • New page tracing/pii-redaction.mdx with feature overview, enablement, scope, placeholder behavior, normalization, and examples
  • Added tracing/pii-redaction to docs.json navigation after introduction
  • Added Note to tracing/introduction.mdx linking to PII redaction
  • Added Tip to tracing/sdks/python/setup.mdx with redaction={"enabled": True} and ZEROEVAL_REDACT_PII=true syntax
  • Added Tip to tracing/sdks/typescript/setup.mdx with redaction: { enabled: true } and ZEROEVAL_REDACT_PII=true syntax
  • Added redaction init parameter to tracing/sdks/python/reference.mdx with snake_case keys table (enabled, redact_inputs, redact_outputs, redact_attributes, redact_errors, redact_session_names, redact_tag_values, sensitive_keys, custom_patterns)
  • Added redaction init option to tracing/sdks/typescript/reference.mdx with camelCase keys table (enabled, redactInputs, redactOutputs, redactAttributes, redactErrors, redactSessionNames, redactTagValues, sensitiveKeys, customPatterns)
  • Added ZEROEVAL_REDACT_PII env var to both reference pages

Open in Capy ZE-8 · 5.4


Note

Low Risk
Documentation-only changes that add a new tracing guide and update Python/TypeScript SDK docs; low risk aside from potential confusion if the documented defaults/options diverge from SDK behavior.

Overview
Adds a new Tracing guide page, tracing/pii-redaction, describing opt-in SDK-side PII redaction (what is redacted, placeholder behavior, normalization, limitations, and runnable examples for Python/TypeScript).

Updates navigation and entry points by linking the new page from tracing/introduction and adding setup tips in both SDK setup guides, plus extends Python/TypeScript SDK reference docs with a redaction init option (including key tables) and the ZEROEVAL_REDACT_PII env var; also tweaks Python init docs to show setup_otlp defaulting to False.

Reviewed by Cursor Bugbot for commit 77090a0. Bugbot is set up for automated code reviews on this repo. Configure here.

@sebastiancrossa sebastiancrossa added the capy Generated by capy.ai label Apr 9, 2026 — with Capy AI
Comment thread tracing/pii-redaction.mdx
@sebastiancrossa sebastiancrossa merged commit d79d938 into main Apr 9, 2026
1 of 3 checks passed
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 9, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
zeroeval 🟢 Ready View Preview Apr 9, 2026, 6:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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

Labels

capy Generated by capy.ai

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant