Skip to content

Commit 9bf40da

Browse files
wishket-pjwJeremyDev87
wishket-pjw
authored and
JeremyDev87
committed
docs: Add multilingual documentation support
Add translations for Korean, Chinese, Japanese, and Spanish: - README files for all 4 languages - Complete documentation translations (getting-started, philosophy, supported-tools) - Language switcher navigation added to all docs close #66
1 parent e592157 commit 9bf40da

21 files changed

Lines changed: 2793 additions & 0 deletions

‎README.es.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<p align="center">
2+
<a href="README.md">English</a> |
3+
<a href="README.ko.md">한국어</a> |
4+
<a href="README.zh-CN.md">中文</a> |
5+
<a href="README.ja.md">日本語</a> |
6+
<a href="README.es.md">Español</a>
7+
</p>
8+
9+
# Codingbuddy
10+
11+
[![CI](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml/badge.svg)](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml)
12+
[![npm version](https://img.shields.io/npm/v/codingbuddy.svg)](https://www.npmjs.com/package/codingbuddy)
13+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
14+
15+
**Una única fuente de verdad para reglas de codificación AI en todos los asistentes de IA.**
16+
17+
Codingbuddy proporciona un sistema de reglas unificado que funciona con Cursor, Claude Code, GitHub Copilot y más, para que todo tu equipo siga los mismos estándares de codificación, independientemente de la herramienta de IA que utilicen.
18+
19+
## ¿Por qué Codingbuddy?
20+
21+
- **Consistencia**: Todas las herramientas de IA siguen estándares de codificación idénticos
22+
- **Fuente única de verdad**: Actualiza las reglas una vez, todas las herramientas se benefician
23+
- **Sin dependencia de proveedor**: Reglas agnósticas de IA que funcionan con cualquier asistente
24+
- **Flujo de trabajo estructurado**: Ciclo de desarrollo PLAN → ACT → EVAL
25+
26+
## Inicio rápido
27+
28+
```bash
29+
# Inicializa tu proyecto (analiza el código base y crea la configuración)
30+
npx codingbuddy init
31+
32+
# Añade a tu herramienta de IA (ejemplo: Claude Desktop)
33+
# Consulta docs/supported-tools.md para otras herramientas de IA
34+
```
35+
36+
Añade a la configuración de Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
37+
38+
```json
39+
{
40+
"mcpServers": {
41+
"codingbuddy": {
42+
"command": "npx",
43+
"args": ["codingbuddy-mcp"]
44+
}
45+
}
46+
}
47+
```
48+
49+
[Guía completa de inicio →](docs/es/getting-started.md)
50+
51+
## Herramientas de IA compatibles
52+
53+
| Herramienta | Estado |
54+
|-------------|--------|
55+
| Claude Code | ✅ Soporte MCP completo |
56+
| Cursor | ✅ Compatible |
57+
| GitHub Copilot | ✅ Compatible |
58+
| Antigravity | ✅ Compatible |
59+
| Amazon Q | ✅ Compatible |
60+
| Kiro | ✅ Compatible |
61+
62+
[Guías de configuración →](docs/es/supported-tools.md)
63+
64+
## Documentación
65+
66+
| Documento | Descripción |
67+
|-----------|-------------|
68+
| [Primeros pasos](docs/es/getting-started.md) | Instalación y configuración rápida |
69+
| [Filosofía](docs/es/philosophy.md) | Visión y principios de diseño |
70+
| [Herramientas compatibles](docs/es/supported-tools.md) | Guías de integración de herramientas IA |
71+
| [Configuración](docs/config-schema.md) | Opciones del archivo de configuración |
72+
| [Referencia API](docs/api.md) | Capacidades del servidor MCP |
73+
| [Desarrollo](docs/development.md) | Contribuir y configuración local |
74+
75+
## Cómo funciona
76+
77+
```
78+
.ai-rules/ ← Reglas compartidas (fuente única de verdad)
79+
├── rules/ ← Reglas principales (flujo de trabajo, calidad)
80+
├── agents/ ← Experiencia especializada (seguridad, rendimiento, etc.)
81+
└── adapters/ ← Guías de integración específicas por herramienta
82+
83+
.cursor/ ← Cursor referencia .ai-rules/
84+
.claude/ ← Claude Code referencia .ai-rules/
85+
.codex/ ← GitHub Copilot referencia .ai-rules/
86+
...
87+
```
88+
89+
Todas las configuraciones de herramientas de IA referencian el mismo directorio `.ai-rules/`. Cambia las reglas una vez, y todas las herramientas siguen los estándares actualizados.
90+
91+
## Contribuir
92+
93+
¡Damos la bienvenida a las contribuciones! Consulta [CONTRIBUTING.md](CONTRIBUTING.md) para las directrices.
94+
95+
## Licencia
96+
97+
MIT © [Codingbuddy](https://github.com/Codingbuddydev)

‎README.ja.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<p align="center">
2+
<a href="README.md">English</a> |
3+
<a href="README.ko.md">한국어</a> |
4+
<a href="README.zh-CN.md">中文</a> |
5+
<a href="README.ja.md">日本語</a> |
6+
<a href="README.es.md">Español</a>
7+
</p>
8+
9+
# Codingbuddy
10+
11+
[![CI](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml/badge.svg)](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml)
12+
[![npm version](https://img.shields.io/npm/v/codingbuddy.svg)](https://www.npmjs.com/package/codingbuddy)
13+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
14+
15+
**すべてのAIアシスタントで統一されたAIコーディングルールの単一ソース。**
16+
17+
Codingbuddyは、Cursor、Claude Code、GitHub Copilotなどと連携する統合ルールシステムを提供し、チーム全体がどのAIツールを使用しても同じコーディング標準に従うことができます。
18+
19+
## なぜCodingbuddyなのか？
20+
21+
- **一貫性**: すべてのAIツールが同一のコーディング標準に従う
22+
- **単一ソース**: ルールを一度更新すれば、すべてのツールに反映
23+
- **ベンダーロックインなし**: AI非依存のルールがあらゆるアシスタントと連携
24+
- **構造化されたワークフロー**: PLAN → ACT → EVAL 開発サイクル
25+
26+
## クイックスタート
27+
28+
```bash
29+
# プロジェクトを初期化（コードベースを分析して設定を作成）
30+
npx codingbuddy init
31+
32+
# AIツールに追加（例：Claude Desktop）
33+
# 他のAIツールについてはdocs/supported-tools.mdを参照
34+
```
35+
36+
Claude Desktop設定に追加（`~/Library/Application Support/Claude/claude_desktop_config.json`）：
37+
38+
```json
39+
{
40+
"mcpServers": {
41+
"codingbuddy": {
42+
"command": "npx",
43+
"args": ["codingbuddy-mcp"]
44+
}
45+
}
46+
}
47+
```
48+
49+
[詳細なセットアップガイド →](docs/ja/getting-started.md)
50+
51+
## 対応AIツール
52+
53+
| ツール | ステータス |
54+
|--------|------------|
55+
| Claude Code | ✅ 完全なMCPサポート |
56+
| Cursor | ✅ 対応 |
57+
| GitHub Copilot | ✅ 対応 |
58+
| Antigravity | ✅ 対応 |
59+
| Amazon Q | ✅ 対応 |
60+
| Kiro | ✅ 対応 |
61+
62+
[セットアップガイド →](docs/ja/supported-tools.md)
63+
64+
## ドキュメント
65+
66+
| ドキュメント | 説明 |
67+
|--------------|------|
68+
| [はじめに](docs/ja/getting-started.md) | インストールとクイックセットアップ |
69+
| [設計思想](docs/ja/philosophy.md) | ビジョンと設計原則 |
70+
| [対応ツール](docs/ja/supported-tools.md) | AIツール統合ガイド |
71+
| [設定リファレンス](docs/config-schema.md) | 設定ファイルオプション |
72+
| [APIリファレンス](docs/api.md) | MCPサーバー機能 |
73+
| [開発ガイド](docs/development.md) | 貢献とローカルセットアップ |
74+
75+
## 仕組み
76+
77+
```
78+
.ai-rules/ ← 共有ルール（単一ソース）
79+
├── rules/ ← コアルール（ワークフロー、品質）
80+
├── agents/ ← スペシャリスト専門知識（セキュリティ、パフォーマンスなど）
81+
└── adapters/ ← ツール固有の統合ガイド
82+
83+
.cursor/ ← Cursorが.ai-rules/を参照
84+
.claude/ ← Claude Codeが.ai-rules/を参照
85+
.codex/ ← GitHub Copilotが.ai-rules/を参照
86+
...
87+
```
88+
89+
すべてのAIツール設定が同じ`.ai-rules/`ディレクトリを参照します。ルールを一度変更すれば、すべてのツールが更新された標準に従います。
90+
91+
## コントリビューション
92+
93+
貢献を歓迎します！ガイドラインについては[CONTRIBUTING.md](CONTRIBUTING.md)をご覧ください。
94+
95+
## ライセンス
96+
97+
MIT © [Codingbuddy](https://github.com/Codingbuddydev)

‎README.ko.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<p align="center">
2+
<a href="README.md">English</a> |
3+
<a href="README.ko.md">한국어</a> |
4+
<a href="README.zh-CN.md">中文</a> |
5+
<a href="README.ja.md">日本語</a> |
6+
<a href="README.es.md">Español</a>
7+
</p>
8+
9+
# Codingbuddy
10+
11+
[![CI](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml/badge.svg)](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml)
12+
[![npm version](https://img.shields.io/npm/v/codingbuddy.svg)](https://www.npmjs.com/package/codingbuddy)
13+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
14+
15+
**모든 AI 코딩 어시스턴트를 위한 단일 규칙 시스템**
16+
17+
Codingbuddy는 Cursor, Claude Code, GitHub Copilot 등 다양한 AI 도구에서 동일한 코딩 규칙을 적용할 수 있는 통합 시스템을 제공합니다. 팀 전체가 어떤 AI 도구를 사용하든 동일한 코딩 표준을 따를 수 있습니다.
18+
19+
## 왜 Codingbuddy인가?
20+
21+
- **일관성**: 모든 AI 도구가 동일한 코딩 표준을 따름
22+
- **단일 소스**: 규칙을 한 번만 수정하면 모든 도구에 적용
23+
- **벤더 종속 없음**: AI에 구애받지 않는 규칙으로 어떤 어시스턴트와도 호환
24+
- **구조화된 워크플로우**: PLAN → ACT → EVAL 개발 사이클
25+
26+
## 빠른 시작
27+
28+
```bash
29+
# 프로젝트 초기화 (코드베이스를 분석하고 설정 파일 생성)
30+
npx codingbuddy init
31+
32+
# AI 도구에 추가 (예: Claude Desktop)
33+
# 다른 AI 도구는 docs/ko/supported-tools.md 참조
34+
```
35+
36+
Claude Desktop 설정 파일에 추가 (`~/Library/Application Support/Claude/claude_desktop_config.json`):
37+
38+
```json
39+
{
40+
"mcpServers": {
41+
"codingbuddy": {
42+
"command": "npx",
43+
"args": ["codingbuddy-mcp"]
44+
}
45+
}
46+
}
47+
```
48+
49+
[전체 시작 가이드 →](docs/ko/getting-started.md)
50+
51+
## 지원 AI 도구
52+
53+
| 도구 | 상태 |
54+
|------|------|
55+
| Claude Code | ✅ 전체 MCP 지원 |
56+
| Cursor | ✅ 지원 |
57+
| GitHub Copilot | ✅ 지원 |
58+
| Antigravity | ✅ 지원 |
59+
| Amazon Q | ✅ 지원 |
60+
| Kiro | ✅ 지원 |
61+
62+
[설정 가이드 →](docs/ko/supported-tools.md)
63+
64+
## 문서
65+
66+
| 문서 | 설명 |
67+
|------|------|
68+
| [시작하기](docs/ko/getting-started.md) | 설치 및 빠른 설정 |
69+
| [철학](docs/ko/philosophy.md) | 비전과 설계 원칙 |
70+
| [지원 도구](docs/ko/supported-tools.md) | AI 도구 통합 가이드 |
71+
| [설정](docs/config-schema.md) | 설정 파일 옵션 |
72+
| [API 레퍼런스](docs/api.md) | MCP 서버 기능 |
73+
| [개발 가이드](docs/development.md) | 기여 및 로컬 설정 |
74+
75+
## 작동 방식
76+
77+
```
78+
.ai-rules/ ← 공유 규칙 (단일 소스)
79+
├── rules/ ← 핵심 규칙 (워크플로우, 품질)
80+
├── agents/ ← 전문가 에이전트 (보안, 성능 등)
81+
└── adapters/ ← 도구별 통합 가이드
82+
83+
.cursor/ ← Cursor가 .ai-rules/ 참조
84+
.claude/ ← Claude Code가 .ai-rules/ 참조
85+
.codex/ ← GitHub Copilot이 .ai-rules/ 참조
86+
...
87+
```
88+
89+
모든 AI 도구 설정이 동일한 `.ai-rules/` 디렉토리를 참조합니다. 규칙을 한 번 수정하면 모든 도구가 업데이트된 표준을 따릅니다.
90+
91+
## 기여하기
92+
93+
기여를 환영합니다! 자세한 내용은 [CONTRIBUTING.md](CONTRIBUTING.md)를 참조하세요.
94+
95+
## 라이선스
96+
97+
MIT © [Codingbuddy](https://github.com/Codingbuddydev)

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<p align="center">
2+
<a href="README.md">English</a> |
3+
<a href="README.ko.md">한국어</a> |
4+
<a href="README.zh-CN.md">中文</a> |
5+
<a href="README.ja.md">日本語</a> |
6+
<a href="README.es.md">Español</a>
7+
</p>
8+
19
# Codingbuddy
210

311
[![CI](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml/badge.svg)](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml)

0 commit comments

Comments
 (0)