[FEAT]: add architecture and test-execution-flow diagrams to the Concepts overview#37
Merged
spencrr merged 2 commits intoMay 18, 2026
Conversation
rlundeen2
approved these changes
May 11, 2026
spencrr
approved these changes
May 11, 2026
nina-msft
reviewed
May 12, 2026
nina-msft
reviewed
May 12, 2026
nina-msft
reviewed
May 12, 2026
nina-msft
approved these changes
May 12, 2026
nina-msft
left a comment
Contributor
There was a problem hiding this comment.
small wording nit & tala look at my comments for the lazy load config, otherwise lgtm!
nina-msft
approved these changes
May 18, 2026
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
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.
Summary
Adds two new visual diagrams to the RAMPART documentation and rewrites the Concepts -> Overview page so that the diagrams flow naturally with the surrounding narrative. Also clears out a couple of pre‑existing doc‑warnings unrelated to the diagrams.
What's changed
New diagrams (added to docs/images/):
rampart-architecture-dark.svg(+ .png fallback) - layered architecture showing PyRIT (L1) → RAMPART (L2) → Consumer Package (L3) → Agent Under Test (L4), and where the consumer's AgentAdapter and pytest suite plug in.rampart-execution-flow-dark.svg(+ .png fallback) - request/response cycle for a single test run: Test → Attacks/Probes → AgentAdapter → Agent System and back.docs/concepts/overview.md— restructured:docs/stylesheets/custom.css- small CSS rule to make embedded SVG/PNG diagrams scale to the content column instead of honoring their intrinsic width/height attributes (which previously caused the diagrams to render either squeezed or overflowed).Cleanup of pre‑existing doc warnings (unrelated to the diagrams, but they were noisy in mkdocs serve while iterating):
How to verify
From the RAMPART directory:
Then open Concepts → Overview and check that:
mkdocs serveno longer reports the orphaned‑pages warnings or the broken getting-started/pytest-integration.md#rampart_sinks link warning.Screenshots