Skip to content

AI Guard docs refactor#35869

Draft
obordeau wants to merge 12 commits intomasterfrom
oceane.bordeau/ai-guard-docs-refactor
Draft

AI Guard docs refactor#35869
obordeau wants to merge 12 commits intomasterfrom
oceane.bordeau/ai-guard-docs-refactor

Conversation

@obordeau
Copy link
Copy Markdown
Contributor

@obordeau obordeau commented Apr 9, 2026

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

  1. Extract security signals into dedicated page — Moves the security signals section from the onboarding page to a new signals.md page, with a summary and link left in onboarding.

  2. 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.

  3. 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.

  4. Remove API and SDK sections from onboarding page — Cleans up the onboarding page after content was moved to subpages.

  5. Add Datadog Agent setup section to integrations and SDK pages — Adds the Agent setup prerequisite to automatic integrations, manual integrations, and SDK pages.

  6. 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.

  7. 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.

  8. 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.

  9. 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.

  10. Update SDK docs with tags, sds, and accurate method signatures — Updates Python, JavaScript, and Java SDK docs with tags and sds return fields, fixes parameter descriptions, and adds Java Message.tool() example.

  11. Add SDS category and rule tag attributes to detection rules — Adds @ai_guard.sds.categories and @ai_guard.sds.rule_tags to the detection rules attribute table.

  12. 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:

  • Ready for merge

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant