Skip to content

[DOCS]: Add RAMPART acronym, examples repo references, and contributing nav fix #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nina-msft merged 2 commits into from
May 20, 2026
Merged

[DOCS]: Add RAMPART acronym, examples repo references, and contributing nav fix #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f0c463
Add RAMPART acronym to glossary & landing page, add missing link to C…
nina-msft May 19, 2026
4cc9ff1
Add references to RAMPART Examples repo
nina-msft May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
4 changes: 4 additions & 0 deletions docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
3 changes: 3 additions & 0 deletions docs/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].

Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -25,10 +27,12 @@ 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) |
| 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) |

Expand Down