Skip to content

[Feature Request] Create Integration Guides #31

@vincentkoc

Description

@vincentkoc

Description

Create comprehensive integration guides for all supported IDEs and platforms.

Guides to Create

  1. docs/integrations/cursor.md
  2. docs/integrations/vscode.md
  3. docs/integrations/windsurf.md
  4. docs/integrations/claude-desktop.md
  5. docs/integrations/docker.md
  6. docs/integrations/kubernetes.md

Each Guide Should Include

  • Prerequisites
  • Step-by-step installation
  • Configuration examples
  • Screenshots
  • Troubleshooting
  • Advanced usage

Tasks

  • Create docs/integrations/ directory
  • Write Cursor integration guide
  • Write VS Code integration guide
  • Write Windsurf integration guide
  • Write Claude Desktop integration guide
  • Write Docker integration guide
  • Write Kubernetes integration guide
  • Add screenshots for each
  • Test all instructions
  • Link from main README

Example Structure

# Cursor Integration Guide

## Prerequisites
- Cursor IDE installed
- Opik account with API key

## Installation
1. Step 1 with screenshot
2. Step 2 with screenshot
...

## Configuration
```json
{
  "mcpServers": { ... }
}

Troubleshooting

  • Common issue 1
  • Common issue 2

Metadata

Metadata

Assignees

No one assigned

    Labels

    Feature RequestNew feature or requestdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions