feat(add docs):

Author: msoedov

docs/api_reference.md

@@ -0,0 +1,52 @@
+# API Reference
+
+This section provides detailed information about the Agentic Security API.
+
+## Endpoints
+
+### `/v1/self-probe`
+
+- **Method**: POST
+- **Description**: Used for integration testing.
+- **Request Body**:
+  ```json
+  {
+      "prompt": "<<PROMPT>>"
+  }
+  ```
+
+### `/v1/self-probe-image`
+
+- **Method**: POST
+- **Description**: Probes the image modality.
+- **Request Body**:
+  ```json
+  [
+      {
+          "role": "user",
+          "content": [
+              {
+                  "type": "text",
+                  "text": "What is in this image?"
+              },
+              {
+                  "type": "image_url",
+                  "image_url": {
+                      "url": "data:image/jpeg;base64,<<BASE64_IMAGE>>"
+                  }
+              }
+          ]
+      }
+  ]
+  ```
+
+## Authentication
+
+All API requests require an API key. Include it in the `Authorization` header:
+```
+Authorization: Bearer YOUR_API_KEY
+```
+
+## Further Reading
+
+For more details on API usage, refer to the [Configuration](configuration.md) section.

docs/ci_cd.md

@@ -0,0 +1,37 @@
+# CI/CD Integration
+
+Integrate Agentic Security into your CI/CD pipeline to automate security scans.
+
+## GitHub Actions
+
+Use the provided GitHub Action workflow to perform automated scans:
+
+```yaml
+name: Security Scan
+
+on: [push, pull_request]
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: pip install agentic_security
+      - name: Run security scan
+        run: agentic_security ci
+```
+
+## Custom CI/CD Pipelines
+
+For custom pipelines, ensure the following steps:
+1. Install dependencies.
+2. Run the `agentic_security ci` command.
+
+## Further Reading
+
+For more details on CI/CD integration, refer to the [API Reference](api_reference.md).

docs/configuration.md

@@ -0,0 +1,24 @@
+# Configuration
+
+This section provides information on configuring Agentic Security to suit your needs.
+
+## Default Configuration
+
+The default configuration file is `agesec.toml`. It includes settings for:
+
+- General settings
+- Module configurations
+- Thresholds
+
+## Customizing Configuration
+
+1. Open the `agesec.toml` file in a text editor.
+2. Modify the settings as needed. For example, to change the port:
+   ```toml
+   [modules.AgenticBackend.opts]
+   port = 8718
+   ```
+
+## Advanced Configuration
+
+For advanced configuration options, refer to the [API Reference](api_reference.md).

docs/contributing.md

@@ -0,0 +1,32 @@
+# Contributing
+
+We welcome contributions to Agentic Security! Follow these steps to get started:
+
+## How to Contribute
+
+1. **Fork the Repository**: Click the "Fork" button at the top of the repository page.
+2. **Clone Your Fork**: Clone your forked repository to your local machine.
+   ```bash
+   git clone https://github.com/mmsoedov/agentic_security.git
+   ```
+3. **Create a Branch**: Create a new branch for your feature or bugfix.
+   ```bash
+   git checkout -b feature-name
+   ```
+4. **Make Changes**: Implement your changes and commit them.
+   ```bash
+   git commit -m "Description of changes"
+   ```
+5. **Push Changes**: Push your changes to your fork.
+   ```bash
+   git push origin feature-name
+   ```
+6. **Open a Pull Request**: Go to the original repository and open a pull request.
+
+## Code of Conduct
+
+Please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
+
+## Further Reading
+
+For more details on contributing, refer to the [Documentation](index.md) section.

docs/datasets.md

@@ -0,0 +1,24 @@
+# Dataset Extension
+
+Agentic Security allows you to extend datasets to enhance its capabilities.
+
+## Adding New Datasets
+
+1. Place your dataset files in the `datasets` directory.
+2. Ensure each file contains a `prompt` column for processing.
+
+## Supported Formats
+
+- CSV
+- JSON
+
+## Example
+
+To add a new dataset:
+```bash
+cp my_dataset.csv datasets/
+```
+
+## Further Reading
+
+For more details on dataset formats and processing, refer to the [API Reference](api_reference.md).

docs/getting_started.md

@@ -0,0 +1,23 @@
+# Getting Started
+
+Welcome to Agentic Security! This guide will help you get started with using the tool.
+
+## Quick Start
+
+1. Ensure you have completed the [installation](installation.md) steps.
+2. Run the following command to start the application:
+   ```bash
+   agentic_security
+   ```
+3. Access the application at `http://localhost:8718`.
+
+## Basic Usage
+
+- To view available commands, use:
+  ```bash
+  agentic_security --help
+  ```
+
+## Next Steps
+
+Explore the [Configuration](configuration.md) section to customize your setup.