[FEAT]: Added userguide and API documentation#35
Merged
bashirpartovi merged 6 commits intoApr 30, 2026
Conversation
spencrr
reviewed
Apr 28, 2026
spencrr
left a comment
spencrr
left a comment
Contributor
There was a problem hiding this comment.
looks good so far - I will run this locally soon and have more commentary on the doc content - do we want to setup a github pages workflow separately? Happy to take a look!
Comment on lines
+106
to
+107
| !!! note | ||
| `asyncio_mode = "auto"` is recommended. It lets pytest-asyncio handle `async def test_*` functions automatically, so you don't need to decorate every test with `@pytest.mark.asyncio`. Without it, you must add that decorator to each async test individually. |
Contributor
There was a problem hiding this comment.
do we follow this in our tests?
Contributor
Author
There was a problem hiding this comment.
yes, pyproject for one of our PoCs
Contributor
There was a problem hiding this comment.
sorry, I meant this repo - @pytest.mark.asyncio in RAMPART
Contributor
Author
There was a problem hiding this comment.
no, we don't do that in RAMPART
behnam-o
reviewed
Apr 29, 2026
behnam-o
approved these changes
Apr 29, 2026
spencrr
approved these changes
Apr 29, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 2026
rlundeen2
reviewed
Apr 30, 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
4 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.
Add comprehensive documentation with MkDocs + mkdocstrings
Summary
Adds a full documentation site for RAMPART using MkDocs Material and mkdocstrings. The docs are designed for engineers consuming RAMPART to write safety tests against their own agents — not for RAMPART maintainers.
What's included
Documentation site infrastructure
mkdocs.yml— MkDocs configuration with Material theme, mkdocstrings Python handler, navigation structure, and Mermaid diagram supportdocs/stylesheets/custom.css— Custom theme colors matching the RAMPART logo (dark charcoal + orange-amber)pyproject.toml— Addeddocsdependency group (mkdocs,mkdocs-material,mkdocstrings[python]) and setuptools package-find exclusion forsite/Narrative documentation (hand-written)
API reference (auto-generated from docstrings)
12 pages using
:::mkdocstrings directives — content is pulled directly from source docstrings at build time:Source docstring fixes
Updated docstrings in 5 source files to improve rendered API docs:
::literal blocks to fenced```pythonblocks for proper syntax highlighting in mkdocstringsPromptDriverdocstring — removed inaccurate claim that all drivers are stateless and safe to reuseconverter.py,payloads/__init__.py,payloads/template.py,reporting/json_file.py,pytest_plugin/plugin.pyHow to build
Screenshot