From 7f0c46379078a4b8fdb932b9c85bb394d59ba780 Mon Sep 17 00:00:00 2001 From: Nina Chikanov Date: Tue, 19 May 2026 14:36:11 -0700 Subject: [PATCH 1/2] Add RAMPART acronym to glossary & landing page, add missing link to Contributing Quick Nav table --- docs/glossary.md | 3 +++ docs/index.md | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/glossary.md b/docs/glossary.md index 5420300..64e4449 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -63,6 +63,9 @@ Terms used throughout the RAMPART documentation. **PyRIT** : [Python Risk Identification Tool](https://github.com/microsoft/PyRIT). The upstream library RAMPART builds on. See [PyRIT Integration](concepts/pyrit.md). +**RAMPART** +: [Risk Assessment & Measurement Platform for Agentic Red Teaming](https://github.com/microsoft/rampart). + **ReportSink** : A destination for test run reports. See [`ReportSink`][rampart.reporting.sink.ReportSink]. diff --git a/docs/index.md b/docs/index.md index a1cf483..1803fd2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,9 @@ description: RAMPART is a pytest-native safety testing framework for agentic AI # RAMPART Documentation -**RAMPART** is a pytest-native safety testing framework for agentic AI applications. You write tests that attack or probe your agent, and RAMPART orchestrates the interaction, evaluates the outcome, and reports the results. +**RAMPART**: Risk Assessment & Measurement Platform for Agentic Red Teaming. + +RAMPART is a pytest-native safety testing framework for agentic AI applications. You write tests that attack or probe your agent, and RAMPART orchestrates the interaction, evaluates the outcome, and reports the results. ```python result = await Attacks.xpia( @@ -29,6 +31,7 @@ assert result, result.summary | Write an XPIA attack test | [XPIA Attack](attacks/xpia.md) | | Write a behavioral probe | [Behavioral Probe](probes/behavioral.md) | | Learn testing patterns and best practices | [Usage](usage/index.md) | +| Contribute back to the project | [Contributing](contributing/index.md) | | Look up a class or function | [API Reference](api/index.md) | | Find a term definition | [Glossary](glossary.md) | From 4cc9ff1d9430113b0be2aadca105417c06d1d94a Mon Sep 17 00:00:00 2001 From: Nina Chikanov Date: Tue, 19 May 2026 16:20:49 -0700 Subject: [PATCH 2/2] Add references to RAMPART Examples repo --- docs/getting-started/index.md | 1 + docs/getting-started/quickstart.md | 4 ++++ docs/index.md | 1 + 3 files changed, 6 insertions(+) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index f5d5529..44f3cb3 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -8,3 +8,4 @@ description: Install RAMPART, run your first safety test, and learn how the pyte |------|-------------| | [Installation](installation.md) | Install RAMPART and dependencies | | [Quickstart](quickstart.md) | Build your first safety test end-to-end | +| [RAMPART Examples](https://github.com/microsoft/rampart-examples) | Explore runnable demos | diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 1ccee8a..e3608f6 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -2,6 +2,9 @@ This guide walks you through writing your first RAMPART safety test — from adapter to a passing test run. +!!! tip "Prefer to read working code?" + [`microsoft/rampart-examples`](https://github.com/microsoft/rampart-examples) hosts self-contained demos with a complete adapter, manifest, surface, and red → fix → green test walkthrough you can clone and run. + --- ## Step 1: Install RAMPART @@ -176,3 +179,4 @@ JSON reports are written to `.report/`. - [Writing Tests](../usage/authoring-tests.md) — Adapters, manifests, evaluators, surfaces in depth - [pytest Markers & Fixtures](../usage/pytest-integration.md) — `@harm`, `@trial`, `rampart_sinks` - [Configuration](../usage/configuration.md) — LLMConfig, Persona, AppManifest +- [RAMPART Examples](https://github.com/microsoft/rampart-examples) — Runnable demos showing complete adapter + test setups diff --git a/docs/index.md b/docs/index.md index 1803fd2..41b9ee5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,6 +27,7 @@ assert result, result.summary | If you want to… | Start here | |---|---| | Install RAMPART and run your first test | [Getting Started](getting-started/index.md) | +| Explore runnable, end-to-end demos | [RAMPART Examples](https://github.com/microsoft/rampart-examples) | | Understand how RAMPART works | [Concepts](concepts/overview.md) | | Write an XPIA attack test | [XPIA Attack](attacks/xpia.md) | | Write a behavioral probe | [Behavioral Probe](probes/behavioral.md) |