[FEAT]: Added userguide and API documentation

docs/api/attacks.md

@@ -0,0 +1,7 @@
+# API Reference — Attacks
+
+::: rampart.attacks
+    options:
+      members:
+        - Attacks
+        - XPIAExecution

docs/api/converters.md

@@ -0,0 +1,8 @@
+# API Reference — Converters
+
+Payload converters transform payloads before injection or delivery.
+
+::: rampart.converters
+    options:
+      members:
+        - DocxConverter

docs/api/core-protocols.md

@@ -0,0 +1,61 @@
+# API Reference — Core Protocols
+
+Protocols and ABCs that define RAMPART's extension points. Implement these to connect your agent, data sources, and custom logic to the framework.
+
+## Session & Adapter
+
+::: rampart.core.adapter
+    options:
+      members:
+        - Session
+        - AgentAdapter
+
+## Evaluator
+
+::: rampart.core.evaluator
+    options:
+      members:
+        - Evaluator
+        - BaseEvaluator
+
+## Prompt Driver
+
+::: rampart.core.prompt_driver
+    options:
+      members:
+        - PromptDriver
+
+## Surface & Injection
+
+::: rampart.core.injection
+    options:
+      members:
+        - Surface
+        - InjectionHandle
+        - sleep_until_ready
+
+## Converter
+
+::: rampart.core.converter
+    options:
+      members:
+        - PayloadConverter
+
+## Execution
+
+::: rampart.core.execution
+    options:
+      members:
+        - BaseExecution
+        - ExecutionEvent
+        - ExecutionEventData
+        - ExecutionEventHandler
+        - ExecutionHandlerFactory
+        - register_default_handler_factory
+        - clear_default_handler_factory
+
+## Errors
+
+::: rampart.core.errors
+    options:
+      show_source: false

docs/api/core-types.md

@@ -0,0 +1,58 @@
+# API Reference — Core Types
+
+Data types shared across the entire framework. All importable from `rampart` directly.
+
+## Data Types
+
+::: rampart.core.types
+    options:
+      members:
+        - Payload
+        - PayloadFormat
+        - Request
+        - Response
+        - ToolCall
+        - SideEffect
+        - Turn
+        - EvalOutcome
+        - EvalResult
+        - EvalContext
+        - ObservabilityLevel
+
+## Result Types
+
+::: rampart.core.result
+    options:
+      members:
+        - Result
+        - SafetyStatus
+        - HarmCategory
+        - InjectionRecord
+        - resolve_as_attack
+        - resolve_as_probe
+
+## Configuration
+
+::: rampart.core.llm
+    options:
+      members:
+        - LLMConfig
+
+::: rampart.core.persona
+    options:
+      members:
+        - Persona
+
+::: rampart.core.prompt_driver
+    options:
+      members:
+        - PromptDecision
+
+## Manifest
+
+::: rampart.core.manifest
+    options:
+      members:
+        - AppManifest
+        - ToolDeclaration
+        - DataSource

docs/api/drivers.md

@@ -0,0 +1,9 @@
+# API Reference — Drivers
+
+Drivers generate prompts for agent interaction. They decide **what** to send; the execution strategy handles the session, evaluation, and result.
+
+::: rampart.drivers
+    options:
+      members:
+        - StaticDriver
+        - LLMDriver

docs/api/evaluators.md

@@ -0,0 +1,10 @@
+# API Reference — Evaluators
+
+Built-in evaluators. All extend `BaseEvaluator` and support composition via `|`, `&`, `~`.
+
+::: rampart.evaluators
+    options:
+      members:
+        - ToolCalled
+        - ResponseContains
+        - SideEffectOccurred

docs/api/index.md

@@ -0,0 +1,17 @@
+# API Reference
+
+API reference organized by RAMPART's package layout. Each page documents the public symbols in one module, auto-generated from source docstrings.
+
+| Page | Contents |
+|------|----------|
+| [Core Types](core-types.md) | `Payload`, `Request`, `Response`, `Turn`, `Result`, `SafetyStatus`, `HarmCategory`, and more |
+| [Core Protocols](core-protocols.md) | `Session`, `AgentAdapter`, `Evaluator`, `Surface`, `InjectionHandle`, and more |
+| [Attacks](attacks.md) | `Attacks.xpia()`, `XPIAExecution` |
+| [Probes](probes.md) | `Probes.behavior()`, `SingleTurnExecution` |
+| [Evaluators](evaluators.md) | `ToolCalled`, `ResponseContains`, `SideEffectOccurred` |
+| [Drivers](drivers.md) | `StaticDriver`, `LLMDriver` |
+| [Payloads](payloads.md) | `Payloads`, `PayloadTemplate`, `PayloadStore` |
+| [Surfaces](surfaces.md) | `OneDriveSurface` |
+| [Converters](converters.md) | `DocxConverter` |
+| [Reporting](reporting.md) | `ReportSink`, `TestRunReport`, `JsonFileReportSink` |
+| [pytest Plugin](pytest-plugin.md) | `record_result`, markers, hooks |

docs/api/payloads.md

@@ -0,0 +1,15 @@
+# API Reference — Payloads
+
+LLM-driven payload generation, templating, and persistence.
+
+::: rampart.payloads.Payloads
+    options:
+      show_root_heading: true
+
+::: rampart.payloads.template.PayloadTemplate
+    options:
+      show_root_heading: true
+
+::: rampart.payloads._store.PayloadStore
+    options:
+      show_root_heading: true

docs/api/probes.md

@@ -0,0 +1,7 @@
+# API Reference — Probes
+
+::: rampart.probes
+    options:
+      members:
+        - Probes
+        - SingleTurnExecution

docs/api/pytest-plugin.md

@@ -0,0 +1,16 @@
+# API Reference — pytest Plugin
+
+RAMPART's pytest integration. Activates automatically when installed.
+
+::: rampart.pytest_plugin._collection
+    options:
+      members:
+        - record_result
+        - ResultCollectionHandler
+        - ResultCollector
+
+::: rampart.pytest_plugin._session
+    options:
+      members:
+        - RampartSession
+        - TrialGroupResult

docs/api/reporting.md

@@ -0,0 +1,11 @@
+# API Reference — Reporting
+
+Reporting infrastructure for persisting test results.
+
+::: rampart.reporting
+    options:
+      members:
+        - ReportSink
+        - TestRunReport
+        - PopulationSummary
+        - JsonFileReportSink

docs/api/surfaces.md

@@ -0,0 +1,8 @@
+# API Reference — Surfaces
+
+Built-in injectable surfaces.
+
+::: rampart.surfaces
+    options:
+      members:
+        - OneDriveSurface

docs/attacks/index.md

@@ -0,0 +1,11 @@
+# Attacks
+
+For background on what attacks are and how they work, see [Concepts: Attacks](../concepts/attacks.md).
+
+## Available Attack Types
+
+| Attack | Factory Method | Description |
+|--------|---------------|-------------|
+| [XPIA](xpia.md) | `Attacks.xpia(...)` | Cross-Prompt Injection Attack |
+
+More attack types will be added.