Skip to content

chore: update documentation links #129

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It supports multiple LLM providers, and can be used to test prompts, agents, MCP

- 🎯 **Security Testing**: Test against 8+ attack strategies including prompt injection, jailbreaking, and context manipulation
- 📊 **Compliance Analysis**: Ensure your systems meet industry standards and best practices
- 🤖 **Provider Support**: Works with multiple LLM providers via LiteLLM. See [Supported Providers](./supported-providers.md) for more details.
- 🤖 **Provider Support**: Works with multiple LLM providers via LiteLLM. See [Supported Providers](./supported_providers.md) for more details.
- 📈 **Visual Dashboard**: Interactive UI for analyzing test results
- ⚡ **End to End Testing**: Test your AI systems end to end
- 📄 **Detailed Reporting**: Comprehensive reports with actionable insights
Expand All @@ -32,7 +32,7 @@ It supports multiple LLM providers, and can be used to test prompts, agents, MCP
- Installation Methods
- Environment Setup

- [🧑🏻‍💻 Release Guide](./release_guide.md)
- [🧑🏻‍💻 Release Guide](./releaseguide.md)
- Release Process
- Pre-release Guide
- Full Release Guide
4 changes: 2 additions & 2 deletions docs/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Validating configs/my_config.yaml...
- Invalid strategy: invalid_strategy
```

## See Also
## Related Commands

- [Test Command](test.md) - For running prompt tests
- [Configuration Guide](../configuration/index.md) - For detailed configuration information
- [Configuration Guide](../configuration.md) - For detailed configuration information
4 changes: 2 additions & 2 deletions docs/cli/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ strategies_config:

Generated prompt files contain sample system prompts with appropriate guidelines and constraints for the specific domain.

## See Also
## Related Commands

- [Test Command](test.md) - For testing prompts
- [Configuration Guide](../configuration/index.md) - For detailed configuration information
- [Configuration Guide](../configuration.md) - For detailed configuration information
4 changes: 2 additions & 2 deletions docs/cli/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Report files are in JSON format with the following structure:
}
```

## See Also
## Related Commands

- [Test Command](test.md) - For running prompt tests
- [Configuration Guide](../configuration/index.md) - For information about test configuration
- [Configuration Guide](../configuration.md) - For information about test configuration
4 changes: 2 additions & 2 deletions docs/cli/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Enable verbose output for more detailed information:
python -m cli.main test --prompt "You are a helpful assistant." --verbose
```

## See Also
## Related Commands

- [Report Command](report.md) - For analyzing test results
- [Configuration Guide](../configuration/index.md) - For creating configuration files
- [Configuration Guide](../configuration.md) - For creating configuration files
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,32 @@ Compliant LLM is your comprehensive toolkit for securing your AI systems. Whethe

## 📚 Documentation Contents

- [🚀 Getting Started](/?file=getting_started)
- [🚀 Getting Started](getting_started.md)
- Installation
- Quick Start Guide
- Basic Usage Examples

- [⚙️ Configuration Guide](/?file=configuration)
- [⚙️ Configuration Guide](configuration.md)
- YAML Configuration
- Environment Variables
- Advanced Settings

- [📦 Installation](/?file=installation)
- [📦 Installation](installation.md)
- System Requirements
- Installation Methods
- Environment Setup

- [🛠️ Development](/?file=development)
- [🛠️ Development](development.md)
- Setting up the development environment
- Running Commands
- Running Tests
- Releasing a new version

- [🧪 Testing](/?file=testing/index)
- [🧪 Testing](testing/index.md)
- Prompt testing
- Blackbox testing

- [🔒 Compliant LLM - Premium Features](/?file=premium)
- [🔒 Compliant LLM - Premium Features](premium.md)
- Internal policy hub integration
- Single controlpane for multiple compliance frameworks
- Audit Trail and reporting
Expand Down
30 changes: 30 additions & 0 deletions docs/providers/google.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Setup Google/Gemini

```bash
export GOOGLE_API_KEY="your-api-key"
```

## Usage

```bash
# Using Gemini Pro
compliant-llm test --prompt "Your prompt here" --provider "google/gemini-pro"

# Using Gemini Pro Vision
compliant-llm test --prompt "Your prompt here" --provider "google/gemini-pro-vision"
```

## Configuration

Add to your YAML configuration:

```yaml
provider: google/gemini-pro
temperature: 0.7
```

## Models

- `google/gemini-pro` - Text generation
- `google/gemini-pro-vision` - Multimodal (text + images)
- `google/gemini-flash` - Faster, more efficient model
2 changes: 1 addition & 1 deletion docs/testing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ To perform black-box testing with Compliant LLM, you'll need:

This approach helps identify potential security gaps in the LLM's implementation and response handling.

[How to run](/?file=testing/blackbox/index)
[How to run](blackbox/index.md)