Where Can I Find Documentation for Corsair? Complete Guide to Repository and Official Resources

Corsair documentation lives in the repository's docs/ folder, package-level READMEs, and the official website at corsair.dev. This guide maps exactly where to find setup instructions, plugin development guides, and API references.

Corsair organizes its documentation across multiple layers — from high-level overviews to integration-specific details. Whether you're installing the core library or building a custom plugin, knowing which files to open saves time and prevents confusion.

Repository Documentation Structure

The corsairdev/corsair repository hosts primary documentation in three locations: the root README, dedicated docs/ guides, and individual package READMEs distributed across the packages/ directory.

Root README and Quick Start

The top-level README.md serves as the entry point. It contains project overview, quick-start links, and pointers to https://corsair.dev for comprehensive tutorials. Start here for installation commands and basic configuration.

# Clone and explore documentation

git clone https://github.com/corsairdev/corsair.git
cd corsair
cat README.md

docs/ Folder: Internal Guides

The docs/ directory contains specialized documentation for contributors and advanced users:

• docs/plugins/README.md — Plugin architecture, registration patterns, and lifecycle hooks
• docs/pr-review-bot.md — Automated PR review workflow configuration

These files assume familiarity with Corsair's core concepts. Review the root README first, then navigate here for extension patterns.

Package-Level Documentation

Each integration package under packages/ ships with its own README documenting integration-specific APIs, authentication requirements, and usage examples.

Core Library Reference

packages/corsair/README.md documents the foundational classes and methods. This is where you'll find the base Plugin class definition and core corsair.registerPlugin() API.

Integration-Specific Guides

Individual integrations provide targeted documentation:

Package Path	Documentation Focus
packages/corsair/README.md	Core library API, Plugin base class, registration methods
packages/webflow/README.md	Webflow API wrapper, page creation, site management
packages/openai/README.md	LLM integration patterns (inferred standard)

Check the corresponding README before importing any integration package.

Official Website Documentation

The public site at https://corsair.dev publishes:

• Full API reference with searchable methods
• Step-by-step tutorials
• Changelog and migration guides

Use the website for learning paths and the repository for implementation details and source code inspection.

Installing Corsair and Using Plugins

The documentation paths above translate directly into working code. Here's how the pieces connect:

Installing the Core Library

// From packages/corsair/README.md
npm install corsair

Using a Published Plugin

// Webflow integration example from packages/webflow/README.md
import { Webflow } from "corsair/webflow";

const wf = new Webflow({ apiKey: process.env.WEBFLOW_API_KEY });
await wf.createPage({ ... });

Building Custom Plugins

Follow docs/plugins/README.md to extend Corsair with custom integrations:

// Custom plugin pattern from docs/plugins/README.md
import { Plugin } from "corsair";

class MyPlugin extends Plugin {
  async run(context) {
    // Custom integration logic with full access to Corsair context
  }
}

corsair.registerPlugin(new MyPlugin());

Navigating the Source for Documentation

When documentation lacks specifics, the source code provides definitive answers. Key exploration patterns:

1. Find integration entry points in packages/<name>/src/index.ts
2. Review test files for implementation examples
3. Check type definitions for complete method signatures

The Plugin base class in packages/corsair/src/plugin.ts (implied path) defines the contract all plugins must implement.

Summary

• Start at README.md for installation and overview
• Consult docs/plugins/README.md for extension development
• Read packages/<integration>/README.md for API-specific usage
• Reference https://corsair.dev for tutorials and comprehensive guides
• Explore source in packages/ for implementation details not covered in docs

Documentation is distributed intentionally — repository files for developers who read code, the website for structured learning.

Frequently Asked Questions

Where is the Corsair API reference documentation?

The API reference is published at https://corsair.dev. The repository's packages/corsair/README.md provides core library documentation, but exhaustive method documentation lives on the official site.

How do I create a custom Corsair plugin?

Read docs/plugins/README.md in the repository root. It covers plugin architecture, the Plugin base class, and registration via corsair.registerPlugin(). The file includes lifecycle patterns and context access details.

What documentation exists for specific integrations like Webflow?

Each integration maintains its own README at packages/<integration>/README.md. For Webflow specifically, see packages/webflow/README.md for authentication, site management, and page creation APIs.

Is there documentation for Corsair's automated PR review bot?

Yes. The docs/pr-review-bot.md file describes the automated PR review workflow, configuration options, and integration with the development pipeline.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}