opencroc 0.1.6 → 0.3.1

package/README.en.md

@@ -0,0 +1,317 @@
+<p align="center">
+  <img src="assets/banner.png" alt="OpenCroc banner" width="820" />
+</p>
+
+<h1 align="center">OpenCroc</h1>
+
+<p align="center">
+  <strong>AI-native E2E testing framework that reads your source code, generates tests, and self-heals failures.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/opencroc"><img src="https://img.shields.io/npm/v/opencroc?color=green" alt="npm version" /></a>
+  <a href="https://github.com/opencroc/opencroc/actions/workflows/ci.yml"><img src="https://github.com/opencroc/opencroc/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
+  <a href="https://github.com/opencroc/opencroc/blob/main/LICENSE"><img src="https://img.shields.io/github/license/opencroc/opencroc" alt="MIT License" /></a>
+  <a href="https://opencroc.com"><img src="https://img.shields.io/badge/docs-opencroc.com-blue" alt="Documentation" /></a>
+</p>
+
+<p align="center">
+  <a href="README.en.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja.md">日本語</a>
+</p>
+
+---
+
+## What is OpenCroc?
+
+OpenCroc is an **AI-native end-to-end testing framework** built on top of [Playwright](https://playwright.dev). Instead of writing test scripts by hand, OpenCroc **reads your backend source code** (models, controllers, DTOs) and automatically generates complete E2E test suites, including API chains, seed data, request bodies, and assertions.
+
+When tests fail, OpenCroc does not just report errors. It **traces the root cause** through the full request chain, **generates fix patches**, and **re-runs tests to verify the fix** autonomously.
+
+### Key Capabilities
+
+| Capability | Description |
+|---|---|
+| **Source-Aware Test Generation** | Parses Sequelize/TypeORM models, Express/NestJS controllers, and DTO decorators via [ts-morph](https://ts-morph.com) to understand your API surface |
+| **AI-Driven Configuration** | LLM generates request body templates, seed data, parameter mappings, validated by 3-layer verification (schema -> semantic -> dry-run) |
+| **Intelligent Chain Planning** | Builds API dependency DAGs, performs topological sorting, and plans test chains with greedy coverage optimization |
+| **Log-Driven Completion Detection** | Goes beyond `networkidle`; verifies request completion by matching backend execution logs (`api_exec end`) |
+| **Failure Chain Attribution** | Traces failures through the full call chain: network errors -> slow APIs -> backend logs -> root cause |
+| **Controlled Self-Healing** | `backup -> AI patch -> dry-run -> apply -> re-run -> verify -> rollback`, with safety gates at every step |
+| **Impact Analysis** | BFS traversal of foreign key relations to map blast radius and auto-generate Mermaid diagrams |
+
+## Quick Start
+
+### Prerequisites
+
+- Node.js >= 18
+- A backend project with Express/NestJS + Sequelize/TypeORM
+
+### Installation
+
+```bash
+npm install opencroc --save-dev
+```
+
+### Initialize
+
+```bash
+npx opencroc init
+```
+
+This will:
+1. Scan your project structure
+2. Detect your ORM and framework
+3. Create `opencroc.config.ts` with sensible defaults
+4. Generate a sample test suite
+
+### Generate Tests
+
+```bash
+# Generate tests for a single module
+npx opencroc generate --module=knowledge-base
+
+# Generate tests for all detected modules
+npx opencroc generate --all
+
+# Dry-run (preview without writing files)
+npx opencroc generate --all --dry-run
+```
+
+### Run Tests
+
+```bash
+# Run all generated tests
+npx opencroc test
+
+# Run specific module
+npx opencroc test --module=knowledge-base
+
+# Run with self-healing enabled
+npx opencroc test --self-heal
+```
+
+### Validate AI Configs
+
+```bash
+# Validate generated configurations
+npx opencroc validate --all
+
+# Compare AI-generated vs baseline results
+npx opencroc compare --baseline=report-a.json --current=report-b.json
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                     CLI / Orchestrator                       │
+├──────────┬──────────┬──────────┬──────────┬─────────────────┤
+│  Source   │  Chain   │  Test    │ Execution│   Self-Healing  │
+│  Parser   │ Planner  │Generator │  Engine  │     Engine      │
+│           │          │          │          │                 │
+│ ts-morph  │ DAG +    │ Template │Playwright│ AI Attribution  │
+│ Model     │ Topo     │ + AI     │ + Log    │ + Controlled    │
+│ Controller│ Sort +   │ Config   │ Driven   │ Fix + Verify    │
+│ DTO       │ Greedy   │ Merge    │ Assert   │ + Rollback      │
+├──────────┴──────────┴──────────┴──────────┴─────────────────┤
+│              Observation Bus (Network + Backend Logs)         │
+├──────────────────────────────────────────────────────────────┤
+│              Report Engine (HTML / JSON / Markdown)           │
+└──────────────────────────────────────────────────────────────┘
+```
+
+### 6-Stage Pipeline
+
+```
+Source Scan -> ER Diagram -> API Analysis -> Chain Planning -> Test Generation -> Failure Analysis
+     │            │             │              │                │                  │
+  ts-morph    Mermaid      Dependency       Topological     Playwright +      Root Cause +
+  parsing     erDiagram    DAG builder      + greedy        AI body/seed      Impact map
+```
+
+## How It Works
+
+### 1. Source Parsing
+
+OpenCroc uses [ts-morph](https://ts-morph.com) to statically analyze your backend:
+
+- **Models**: Extracts table names, column types, indexes, and foreign keys from Sequelize `Model.init()` / TypeORM `@Entity()`
+- **Controllers**: Extracts routes, HTTP methods, and path parameters from Express `router.get/post/put/delete`
+- **DTOs**: Extracts validation rules from `@IsString()`, `@IsNumber()`, `@IsOptional()` decorators
+
+### 2. AI Configuration Generation
+
+For each module, OpenCroc calls an LLM (OpenAI / ZhiPu / any OpenAI-compatible API) to generate:
+
+- **Request body templates**: Field-accurate POST/PUT payloads
+- **Seed data**: `beforeAll` setup steps with correct API sequences
+- **Parameter mappings**: Path parameter aliases (`/:id` -> `categoryId`)
+- **ID aliases**: Preventing ID conflicts across multi-resource chains
+
+Each config is validated through **3 layers**:
+1. **Schema validation**: JSON structure completeness
+2. **Semantic validation**: Field values match source code metadata
+3. **Dry-run validation**: TypeScript compilation check
+
+Failed configs are automatically fixed (up to 3 rounds) before being written.
+
+### 3. Log-Driven Completion
+
+Instead of relying on fragile `networkidle` signals:
+
+```
+Frontend Request -> Backend api_exec start log -> Backend processing -> api_exec end log
+                                                                          ↓
+                                              OpenCroc polls end logs to confirm completion
+```
+
+This catches cases where the frontend appears idle but the backend is still processing.
+
+### 4. Self-Healing Loop
+
+```
+Test Failure
+  -> AI Attribution (LLM + heuristic fallback)
+  -> Generate Fix Patch
+  -> Dry-Run Validation
+  -> Apply Patch (with backup)
+  -> Re-run Failed Tests
+  -> Verify Fix
+  -> Commit or Rollback
+```
+
+## Real-World Validation
+
+OpenCroc has been validated against a **production-scale RBAC system** (multi-tenant enterprise permission management) with 100+ Sequelize models, 75+ Express controllers, and embedded associations:
+
+```
+$ npx tsx examples/rbac-system/smoke-test.ts
+
+Modules        : 5 (default, aigc, data-platform, integration, workflow)
+ER Diagrams    : 5
+  [default] 102 tables, 65 relations
+  [aigc] 6 tables, 0 relations
+  [data-platform] 4 tables, 0 relations
+  [integration] 14 tables, 0 relations
+  [workflow] 2 tables, 0 relations
+Chain Plans    : 5
+  [aigc] 78 chains, 150 steps
+Generated Files: 78
+Duration       : 1153ms
+```
+
+Key findings:
+- **102 tables** and **65 foreign key relations** correctly extracted from flat model layout
+- **Embedded associations** (`.belongsTo()` / `.hasMany()` inside model files) detected without dedicated association files
+- **78 test files** generated across 5 modules in just over 1 second
+- Handles both flat (`models/*.ts`) and nested (`models/module/*.ts`) directory structures
+
+## Configuration
+
+```typescript
+// opencroc.config.ts
+import { defineConfig } from 'opencroc';
+
+export default defineConfig({
+  // Backend source paths
+  backend: {
+    modelsDir: 'src/models',
+    controllersDir: 'src/controllers',
+    servicesDir: 'src/services',
+  },
+
+  // Target application
+  baseUrl: 'http://localhost:3000',
+  apiBaseUrl: 'http://localhost:3000/api',
+
+  // AI configuration
+  ai: {
+    provider: 'openai',        // 'openai' | 'zhipu' | 'custom'
+    apiKey: process.env.AI_API_KEY,
+    model: 'gpt-4o-mini',
+  },
+
+  // Test execution
+  execution: {
+    workers: 4,
+    timeout: 30_000,
+    retries: 1,
+  },
+
+  // Log-driven completion (requires backend instrumentation)
+  logCompletion: {
+    enabled: true,
+    endpoint: '/internal/test-logs',
+    pollIntervalMs: 500,
+    timeoutMs: 10_000,
+  },
+
+  // Self-healing
+  selfHealing: {
+    enabled: false,
+    fixScope: 'config-only',   // 'config-only' | 'config-and-source'
+    maxFixRounds: 3,
+    dryRunFirst: true,
+  },
+});
+```
+
+## Supported Tech Stacks
+
+| Layer | Supported | Planned |
+|---|---|---|
+| **ORM** | Sequelize, TypeORM, Prisma | Drizzle |
+| **Framework** | Express | NestJS, Fastify, Koa |
+| **Test Runner** | Playwright | — |
+| **LLM** | OpenAI, ZhiPu (GLM), Ollama (local) | Anthropic |
+| **Database** | MySQL, PostgreSQL | SQLite, MongoDB |
+
+## Comparison
+
+| Feature | OpenCroc | Playwright | Metersphere | auto-playwright |
+|---|---|---|---|---|
+| Source-aware generation | ✅ | ❌ | ❌ | ❌ |
+| AI config generation + validation | ✅ | ❌ | ❌ | ❌ |
+| Log-driven completion | ✅ | ❌ | ❌ | ❌ |
+| Failure chain attribution | ✅ | ❌ | Partial | ❌ |
+| Self-healing with rollback | ✅ | ❌ | ❌ | ❌ |
+| API dependency DAG | ✅ | ❌ | ❌ | ❌ |
+| Zero-config test generation | ✅ | Codegen only | Manual | NL->action |
+| Impact blast radius analysis | ✅ | ❌ | ❌ | ❌ |
+
+## Roadmap
+
+- [x] 6-stage source-to-test pipeline
+- [x] AI configuration generation with 3-layer validation
+- [x] Controlled self-healing loop
+- [x] Log-driven completion detection
+- [x] Failure chain attribution + impact analysis
+- [x] TypeORM / Prisma adapter
+- [x] Ollama local LLM support
+- [x] Real-world validation (102 tables, 65 relations, 78 generated tests)
+- [x] GitHub Actions / GitLab CI integration
+- [x] VS Code extension scaffold
+- [x] Plugin system
+- [x] HTML / JSON / Markdown report generation
+- [ ] NestJS controller parser
+- [ ] Visual dashboard (opencroc.com)
+- [ ] Drizzle ORM adapter
+
+## Documentation
+
+Visit **[opencroc.com](https://opencroc.com)** for full documentation, or browse:
+
+- [Architecture Guide](docs/architecture.md)
+- [Configuration Reference](docs/configuration.md)
+- [Backend Instrumentation Guide](docs/backend-instrumentation.md)
+- [AI Provider Setup](docs/ai-providers.md)
+- [Self-Healing Guide](docs/self-healing.md)
+- [Troubleshooting](docs/troubleshooting.md)
+
+## Contributing
+
+We welcome contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+[MIT](LICENSE) © 2026 OpenCroc Contributors

package/README.ja.md

@@ -0,0 +1,317 @@
+<p align="center">
+  <img src="assets/banner.png" alt="OpenCroc バナー" width="820" />
+</p>
+
+<h1 align="center">OpenCroc</h1>
+
+<p align="center">
+  <strong>ソースコードを読み取り、テストを自動生成し、失敗を自己修復する AI ネイティブ E2E テストフレームワーク。</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/opencroc"><img src="https://img.shields.io/npm/v/opencroc?color=green" alt="npm version" /></a>
+  <a href="https://github.com/opencroc/opencroc/actions/workflows/ci.yml"><img src="https://github.com/opencroc/opencroc/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
+  <a href="https://github.com/opencroc/opencroc/blob/main/LICENSE"><img src="https://img.shields.io/github/license/opencroc/opencroc" alt="MIT License" /></a>
+  <a href="https://opencroc.com"><img src="https://img.shields.io/badge/docs-opencroc.com-blue" alt="Documentation" /></a>
+</p>
+
+<p align="center">
+  <a href="README.en.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja.md">日本語</a>
+</p>
+
+---
+
+## OpenCroc とは
+
+OpenCroc は [Playwright](https://playwright.dev) 上に構築された **AI ネイティブ E2E テストフレームワーク** です。手作業で大量のテストスクリプトを書く代わりに、OpenCroc は**バックエンドのソースコード**（モデル、コントローラー、DTO）を解析し、API チェーン、シードデータ、リクエストボディ、アサーションを含む E2E テストスイートを自動生成します。
+
+テストが失敗した場合、単なるエラー出力で終わりません。リクエストチェーン全体をたどって**根本原因を特定**し、**修正パッチを生成**し、**再実行で修正を検証**します。
+
+### 主な機能
+
+| 機能 | 説明 |
+|---|---|
+| **ソースコード認識型テスト生成** | [ts-morph](https://ts-morph.com) で Sequelize/TypeORM モデル、Express/NestJS コントローラー、DTO デコレーターを解析し API 面を把握 |
+| **AI 駆動の設定生成** | LLM がリクエストテンプレート、シードデータ、パラメータマッピングを生成し、3層検証（schema -> semantic -> dry-run）で確認 |
+| **インテリジェントなチェーン計画** | API 依存 DAG を構築し、トポロジカルソートと貪欲最適化でテストチェーンを設計 |
+| **ログ駆動の完了判定** | `networkidle` を超えて、バックエンド実行ログ（`api_exec end`）で完了を検証 |
+| **失敗チェーンの原因追跡** | ネットワークエラー -> 遅延 API -> バックエンドログの順で追跡し根因特定 |
+| **制御された自己修復** | `backup -> AI patch -> dry-run -> apply -> re-run -> verify -> rollback` を安全ゲート付きで実行 |
+| **影響範囲分析** | 外部キー関係を BFS でたどり、影響範囲を可視化し Mermaid 図を生成 |
+
+## クイックスタート
+
+### 前提条件
+
+- Node.js >= 18
+- Express/NestJS + Sequelize/TypeORM を利用するバックエンドプロジェクト
+
+### インストール
+
+```bash
+npm install opencroc --save-dev
+```
+
+### 初期化
+
+```bash
+npx opencroc init
+```
+
+このコマンドで以下を実行します:
+1. プロジェクト構成をスキャン
+2. ORM とフレームワークを検出
+3. `opencroc.config.ts` を初期生成
+4. サンプルテストを生成
+
+### テスト生成
+
+```bash
+# 単一モジュールのテスト生成
+npx opencroc generate --module=knowledge-base
+
+# 全モジュールのテスト生成
+npx opencroc generate --all
+
+# ドライラン（ファイルを書き込まない）
+npx opencroc generate --all --dry-run
+```
+
+### テスト実行
+
+```bash
+# 生成済みテストをすべて実行
+npx opencroc test
+
+# 特定モジュールのみ実行
+npx opencroc test --module=knowledge-base
+
+# 自己修復モードで実行
+npx opencroc test --self-heal
+```
+
+### AI 設定の検証
+
+```bash
+# 生成設定を検証
+npx opencroc validate --all
+
+# AI 生成結果とベースラインを比較
+npx opencroc compare --baseline=report-a.json --current=report-b.json
+```
+
+## アーキテクチャ
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                     CLI / Orchestrator                       │
+├──────────┬──────────┬──────────┬──────────┬─────────────────┤
+│  Source   │  Chain   │  Test    │ Execution│   Self-Healing  │
+│  Parser   │ Planner  │Generator │  Engine  │     Engine      │
+│           │          │          │          │                 │
+│ ts-morph  │ DAG +    │ Template │Playwright│ AI Attribution  │
+│ Model     │ Topo     │ + AI     │ + Log    │ + Controlled    │
+│ Controller│ Sort +   │ Config   │ Driven   │ Fix + Verify    │
+│ DTO       │ Greedy   │ Merge    │ Assert   │ + Rollback      │
+├──────────┴──────────┴──────────┴──────────┴─────────────────┤
+│              Observation Bus (Network + Backend Logs)         │
+├──────────────────────────────────────────────────────────────┤
+│              Report Engine (HTML / JSON / Markdown)           │
+└──────────────────────────────────────────────────────────────┘
+```
+
+### 6 段階パイプライン
+
+```
+Source Scan -> ER Diagram -> API Analysis -> Chain Planning -> Test Generation -> Failure Analysis
+     │            │             │              │                │                  │
+  ts-morph    Mermaid      Dependency       Topological     Playwright +      Root Cause +
+  parsing     erDiagram    DAG builder      + greedy        AI body/seed      Impact map
+```
+
+## 仕組み
+
+### 1. ソース解析
+
+OpenCroc は [ts-morph](https://ts-morph.com) を使ってバックエンドを静的解析します。
+
+- **Models**: Sequelize `Model.init()` / TypeORM `@Entity()` からテーブル名、列型、インデックス、外部キーを抽出
+- **Controllers**: Express `router.get/post/put/delete` からルート、HTTP メソッド、パスパラメータを抽出
+- **DTOs**: `@IsString()`、`@IsNumber()`、`@IsOptional()` からバリデーションルールを抽出
+
+### 2. AI 設定生成
+
+各モジュールごとに、OpenCroc は LLM（OpenAI / ZhiPu / OpenAI 互換 API）を呼び出して以下を生成します。
+
+- **リクエストボディテンプレート**: フィールド精度の高い POST/PUT ペイロード
+- **シードデータ**: 正しい API 順序を持つ `beforeAll` セットアップ
+- **パラメータマッピング**: パスパラメータ別名（`/:id` -> `categoryId`）
+- **ID エイリアス**: 複数リソースチェーンでの ID 衝突防止
+
+各設定は **3 層検証** を通過します。
+1. **Schema 検証**: JSON 構造の完全性
+2. **Semantic 検証**: フィールド値がソースメタデータに一致するか
+3. **Dry-run 検証**: TypeScript コンパイル確認
+
+失敗した設定は書き込み前に自動修正（最大 3 ラウンド）されます。
+
+### 3. ログ駆動の完了判定
+
+壊れやすい `networkidle` に依存せず、以下で判定します。
+
+```
+Frontend Request -> Backend api_exec start log -> Backend processing -> api_exec end log
+                                                                          ↓
+                                              OpenCroc polls end logs to confirm completion
+```
+
+フロントが待機状態でもバックエンドが継続処理中のケースを検出できます。
+
+### 4. 自己修復ループ
+
+```
+Test Failure
+  -> AI Attribution (LLM + heuristic fallback)
+  -> Generate Fix Patch
+  -> Dry-Run Validation
+  -> Apply Patch (with backup)
+  -> Re-run Failed Tests
+  -> Verify Fix
+  -> Commit or Rollback
+```
+
+## 実プロジェクト検証
+
+OpenCroc は**本番規模の RBAC システム**（マルチテナント企業権限管理）で検証済みです。100+ の Sequelize モデル、75+ の Express コントローラー、モデルファイル内埋め込みアソシエーションを含みます：
+
+```
+$ npx tsx examples/rbac-system/smoke-test.ts
+
+Modules        : 5 (default, aigc, data-platform, integration, workflow)
+ER Diagrams    : 5
+  [default] 102 tables, 65 relations
+  [aigc] 6 tables, 0 relations
+  [data-platform] 4 tables, 0 relations
+  [integration] 14 tables, 0 relations
+  [workflow] 2 tables, 0 relations
+Chain Plans    : 5
+  [aigc] 78 chains, 150 steps
+Generated Files: 78
+Duration       : 1153ms
+```
+
+主な結果：
+- フラットモデルレイアウトから **102 テーブル** と **65 の外部キー関係** を正確に抽出
+- 専用の association ファイル不要 — モデルファイル内の**埋め込みアソシエーション**（`.belongsTo()` / `.hasMany()`）を検出
+- 5 モジュールで **78 テストファイル** を約1秒で生成
+- フラット（`models/*.ts`）とネスト（`models/module/*.ts`）の両ディレクトリ構造に対応
+
+## 設定例
+
+```typescript
+// opencroc.config.ts
+import { defineConfig } from 'opencroc';
+
+export default defineConfig({
+  // バックエンドソースのパス
+  backend: {
+    modelsDir: 'src/models',
+    controllersDir: 'src/controllers',
+    servicesDir: 'src/services',
+  },
+
+  // 対象アプリケーション
+  baseUrl: 'http://localhost:3000',
+  apiBaseUrl: 'http://localhost:3000/api',
+
+  // AI 設定
+  ai: {
+    provider: 'openai',        // 'openai' | 'zhipu' | 'custom'
+    apiKey: process.env.AI_API_KEY,
+    model: 'gpt-4o-mini',
+  },
+
+  // テスト実行
+  execution: {
+    workers: 4,
+    timeout: 30_000,
+    retries: 1,
+  },
+
+  // ログ駆動完了判定（バックエンド側の計測が必要）
+  logCompletion: {
+    enabled: true,
+    endpoint: '/internal/test-logs',
+    pollIntervalMs: 500,
+    timeoutMs: 10_000,
+  },
+
+  // 自己修復
+  selfHealing: {
+    enabled: false,
+    fixScope: 'config-only',   // 'config-only' | 'config-and-source'
+    maxFixRounds: 3,
+    dryRunFirst: true,
+  },
+});
+```
+
+## 対応技術スタック
+
+| レイヤー | 対応済み | 予定 |
+|---|---|---|
+| **ORM** | Sequelize, TypeORM, Prisma | Drizzle |
+| **Framework** | Express | NestJS, Fastify, Koa |
+| **Test Runner** | Playwright | — |
+| **LLM** | OpenAI, ZhiPu (GLM), Ollama (local) | Anthropic |
+| **Database** | MySQL, PostgreSQL | SQLite, MongoDB |
+
+## 比較
+
+| 機能 | OpenCroc | Playwright | Metersphere | auto-playwright |
+|---|---|---|---|---|
+| ソース認識生成 | ✅ | ❌ | ❌ | ❌ |
+| AI 設定生成 + 検証 | ✅ | ❌ | ❌ | ❌ |
+| ログ駆動完了判定 | ✅ | ❌ | ❌ | ❌ |
+| 失敗チェーン帰属分析 | ✅ | ❌ | Partial | ❌ |
+| 自己修復 + ロールバック | ✅ | ❌ | ❌ | ❌ |
+| API 依存 DAG | ✅ | ❌ | ❌ | ❌ |
+| ゼロ設定テスト生成 | ✅ | Codegen only | Manual | NL->action |
+| 影響範囲分析 | ✅ | ❌ | ❌ | ❌ |
+
+## Roadmap
+
+- [x] 6-stage source-to-test pipeline
+- [x] AI configuration generation with 3-layer validation
+- [x] Controlled self-healing loop
+- [x] Log-driven completion detection
+- [x] Failure chain attribution + impact analysis
+- [x] TypeORM / Prisma adapter
+- [x] Ollama local LLM support
+- [x] Real-world validation (102 tables, 65 relations, 78 generated tests)
+- [x] GitHub Actions / GitLab CI integration
+- [x] VS Code extension scaffold
+- [x] Plugin system
+- [x] HTML / JSON / Markdown report generation
+- [ ] NestJS controller parser
+- [ ] Visual dashboard (opencroc.com)
+- [ ] Drizzle ORM adapter
+
+## ドキュメント
+
+詳細は **[opencroc.com](https://opencroc.com)** を参照してください。あわせて以下も確認できます。
+
+- [Architecture Guide](docs/architecture.md)
+- [Configuration Reference](docs/configuration.md)
+- [Backend Instrumentation Guide](docs/backend-instrumentation.md)
+- [AI Provider Setup](docs/ai-providers.md)
+- [Self-Healing Guide](docs/self-healing.md)
+- [Troubleshooting](docs/troubleshooting.md)
+
+## コントリビュート
+
+貢献を歓迎します。ガイドラインは [CONTRIBUTING.md](CONTRIBUTING.md) を参照してください。
+
+## ライセンス
+
+[MIT](LICENSE) © 2026 OpenCroc Contributors