AI Guard docs refactor#35869
Merged
Merged
Conversation
Contributor
…6, and blocking mode
manuel-alvarez-alvarez
force-pushed
the
oceane.bordeau/ai-guard-docs-refactor
branch
from
April 10, 2026 13:37
a5409ac to
3ce9e7f
Compare
obordeau
marked this pull request as ready for review
April 13, 2026 07:18
avara1986
reviewed
Apr 13, 2026
avara1986
reviewed
Apr 13, 2026
Co-authored-by: Alberto Vara <[email protected]>
Co-authored-by: Alberto Vara <[email protected]>
avara1986
approved these changes
Apr 13, 2026
Member
|
Just out of curiosity, with this documentation update, do you think it’s aligned with the Strands Agent docs? Should we update anything in their documentation as well? |
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
…taDog/documentation into oceane.bordeau/ai-guard-docs-refactor
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
Co-authored-by: Janine Chan <[email protected]>
janine-c
reviewed
Apr 23, 2026
janine-c
left a comment
janine-c
left a comment
Contributor
There was a problem hiding this comment.
Looks great, thanks for applying those edits! Just a couple outstanding things and then we should be good to go!
janine-c
approved these changes
Apr 24, 2026
janine-c
left a comment
janine-c
left a comment
Contributor
There was a problem hiding this comment.
Wonderful! Thank you so much for your help on this!!
…uard-docs-refactor # Conflicts: # content/en/security/ai_guard/onboarding.md
StefonSimmons
approved these changes
Apr 27, 2026
1 task
estherk15
pushed a commit
that referenced
this pull request
May 4, 2026
* feat(ai-guard): extract security signals into dedicated page * feat(ai-guard): extract setup instructions into dedicated page * feat(ai-guard): create setup subpages for integrations, SDK, and HTTP API * refactor(ai-guard): remove API and SDK sections from onboarding page * feat(ai-guard): add Datadog Agent setup section to integrations and SDK pages * refactor(ai-guard): move tracer library install section from setup index to SDK page * refactor(ai-guard): replace Agent setup step with instrumentation options overview * refactor(ai-guard): reorder onboarding sections and trim HTTP API page * feat(ai-guard): update automatic integrations with env vars, AI SDK v6, and blocking mode * fix(ai-guard): update SDK docs with tags, sds, and accurate method signatures * feat(ai-guard): add SDS category and rule tag attributes to detection rules * fix(ai-guard): add warning that HTTP API requests don't appear in Datadog UI * Update versions and build sdk setup partial * Add manual instrumentation docs * Fix links in the sdk setup partial * Fix whitespace trimmers * Improve manual integrations * Update content/en/security/ai_guard/setup/sdk.md Co-authored-by: Alberto Vara <[email protected]> * Update content/en/security/ai_guard/setup/sdk.md Co-authored-by: Alberto Vara <[email protected]> * Ruby: Add content-parts example to AI Guard SDK * Document AI Guard permissions in setup guide (#36087) Add a Required permissions table to the AI Guard setup prerequisites listing AI Guard Evaluate, AI Guard View, AI Guard Write, and User Access Manage with their roles. Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * Fix sensitive data link * Update content/en/security/ai_guard/setup/automatic_integrations.md Co-authored-by: Janine Chan <[email protected]> * Fix langchain links * Update content/en/security/ai_guard/setup/automatic_integrations.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/manual_integrations.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/sdk.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/signals.md Co-authored-by: Janine Chan <[email protected]> * Update content/en/security/ai_guard/setup/http_api.md Co-authored-by: Janine Chan <[email protected]> * Use headers instead of collapse * Remove private true * Remove tabs * Update header size * Remove mardown in partial * Remove langchain dead link * Remove collapses * Update content/en/security/ai_guard/setup/_index.md Co-authored-by: Janine Chan <[email protected]> * refactor(ai-guard): rename tracer references to SDK --------- Co-authored-by: Manuel Álvarez Álvarez <[email protected]> Co-authored-by: Alberto Vara <[email protected]> Co-authored-by: Yury Lebedev <[email protected]> Co-authored-by: Emmanuelle Lejeail <[email protected]> Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]> Co-authored-by: Janine Chan <[email protected]>
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
7 participants
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 does this PR do? What is the motivation?
Refactors the AI Guard documentation from a single onboarding page into a structured multi-page layout.
Commit-by-commit breakdown
Extract security signals into dedicated page — Moves the security signals section from the onboarding page to a new
signals.mdpage, with a summary and link left in onboarding.Extract setup instructions into dedicated page — Moves the full setup steps (prerequisites, API keys, Agent, retention filter, policies, access control) from the onboarding page to a new
setup/section.Create setup subpages for integrations, SDK, and HTTP API — Creates four subpages under setup: automatic integrations, manual integrations, SDK, and HTTP API. Moves SDK and REST API content from onboarding into their respective pages.
Remove API and SDK sections from onboarding page — Cleans up the onboarding page after content was moved to subpages.
Add Datadog Agent setup section to integrations and SDK pages — Adds the Agent setup prerequisite to automatic integrations, manual integrations, and SDK pages.
Move tracer library install section from setup index to SDK page — Moves the tracer install instructions (Python, JS, Java, Ruby) to the SDK page where they belong.
Replace Agent setup step with instrumentation options overview — Replaces step 3 in the setup index with an overview of all instrumentation options (SDK, automatic integrations, manual integrations, HTTP API) with links to each subpage.
Reorder onboarding sections and trim HTTP API page — Reorders sections in onboarding and removes env vars table and request message format from the HTTP API page.
Update automatic integrations with env vars, AI SDK v6, and blocking mode — Updates automatic integrations page with the correct AI SDK v6 version, required environment variables, and blocking mode documentation.
Update SDK docs with tags, sds, and accurate method signatures — Updates Python, JavaScript, and Java SDK docs with
tagsandsdsreturn fields, fixes parameter descriptions, and adds JavaMessage.tool()example.Add SDS category and rule tag attributes to detection rules — Adds
@ai_guard.sds.categoriesand@ai_guard.sds.rule_tagsto the detection rules attribute table.Add warning that HTTP API requests don't appear in Datadog UI — Adds a warning banner explaining that HTTP API evaluations don't send traces to Datadog.
Merge instructions
Merge readiness: