golem15/msd-core
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #273 from open-gsd/fix/196-i18n-remove-sdk-doc-refs

Browse Source 
docs(#196): align localized docs with sdk retirement wording
This commit is contained in:
Tom Boucher
2026-05-25 12:07:13 -04:00
committed by GitHub
parent 58439a770d b64ffc12ed
commit 45bb3ac95e
10 changed files with 25 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/ja-JP/FEATURES.md
View File

@@ -73,8 +73,6 @@
- [v1.29 の機能](#v129-の機能)
- [Windsurf ランタイムサポート](#56-windsurf-ランタイムサポート)
- [国際化ドキュメント](#57-国際化ドキュメント)
- [v1.30 の機能](#v130-の機能)
- [GSD SDK](#58-gsd-sdk)
- [v1.31 の機能](#v131-の機能)
- [スキーマドリフト検出](#59-スキーマドリフト検出)
- [セキュリティエンフォースメント](#60-セキュリティエンフォースメント)
@@ -1358,26 +1356,6 @@ Claude が GSD ワークフローコンテキスト外でファイル編集を
---
## v1.30 の機能
### 58. GSD SDK
**コマンド:** プログラマティック API（ヘッドレス）
**目的:** CLI セッションなしでプログラムから GSD ワークフローを実行するためのヘッドレス TypeScript SDK。
**要件:**
- REQ-SDK-01: SDK は GSD ワークフロー操作を TypeScript 関数として公開しなければならない
- REQ-SDK-02: SDK はインタラクティブプロンプトなしのヘッドレス実行をサポートしなければならない
- REQ-SDK-03: SDK は CLI 駆動ワークフローと同一のアーティファクトを生成しなければならない
**プロセス:**
1. **インポート** — GSD SDK を TypeScript/JavaScript プロジェクトにインポート
2. **設定** — プロジェクトパスとワークフローオプションをプログラムから設定
3. **実行** — API コールで GSD フェーズ（discuss、plan、execute）を実行
---
## v1.31 の機能
### 59. スキーマドリフト検出
@@ -1680,7 +1658,7 @@ Claude が GSD ワークフローコンテキスト外でファイル編集を
### 74. コンテキスト削減
**対象:** GSD SDK プロンプトアセンブリ
**対象:** プロンプトアセンブリ・パイプライン
**目的:** Markdown 切り詰めとキャッシュフレンドリーなプロンプト順序により、コンテキストプロンプトサイズを削減します。

2
docs/ja-JP/README.md
View File

@@ -10,7 +10,7 @@ Get Shit Done（GSD）フレームワークの包括的なドキュメントで
| [機能リファレンス](FEATURES.md) | 全ユーザー | 全機能の詳細ドキュメントと要件 |
| [コマンドリファレンス](COMMANDS.md) | 全ユーザー | 全コマンドの構文、フラグ、オプション、使用例 |
| [設定リファレンス](CONFIGURATION.md) | 全ユーザー | 設定スキーマ、ワークフロートグル、モデルプロファイル、Git ブランチ |
| [CLI ツールリファレンス](CLI-TOOLS.md) | コントリビューター、エージェント作成者 | CJS `gsd-tools.cjs` と **`gsd-sdk query` / SDK** のガイド |
| [CLI ツールリファレンス](CLI-TOOLS.md) | コントリビューター、エージェント作成者 | CJS `gsd-tools.cjs` と `gsd-tools.cjs query` 가이드 のガイド |
| [エージェントリファレンス](AGENTS.md) | コントリビューター、上級ユーザー | 全18種の専門エージェント — 役割、ツール、スポーンパターン |
| [ユーザーガイド](USER-GUIDE.md) | 全ユーザー | ワークフローのウォークスルー、トラブルシューティング、リカバリー |
| [コンテキストモニター](context-monitor.md) | 全ユーザー | コンテキストウィンドウ監視フックのアーキテクチャ |

24
docs/ko-KR/FEATURES.md
View File

@@ -73,8 +73,6 @@
- [v1.29 기능](#v129-기능)
- [Windsurf 런타임 지원](#56-windsurf-런타임-지원)
- [국제화 문서](#57-국제화-문서)
- [v1.30 기능](#v130-기능)
- [GSD SDK](#58-gsd-sdk)
- [v1.31 기능](#v131-기능)
- [스키마 드리프트 감지](#59-스키마-드리프트-감지)
- [보안 시행](#60-보안-시행)
@@ -1358,26 +1356,6 @@ Claude가 GSD 워크플로우 컨텍스트 밖에서 파일 편집을 시도하
---
## v1.30 기능
### 58. GSD SDK
**명령어:** 프로그래매틱 API (헤드리스)
**목적:** CLI 세션 없이 프로그래밍 방식으로 GSD 워크플로우를 실행하기 위한 헤드리스 TypeScript SDK.
**요구사항.**
- REQ-SDK-01: SDK는 GSD 워크플로우 작업을 TypeScript 함수로 노출해야 합니다.
- REQ-SDK-02: SDK는 대화형 프롬프트 없이 헤드리스 실행을 지원해야 합니다.
- REQ-SDK-03: SDK는 CLI 기반 워크플로우와 동일한 아티팩트를 생성해야 합니다.
**프로세스.**
1. **임포트** — TypeScript/JavaScript 프로젝트에 GSD SDK 임포트
2. **구성** — 프로젝트 경로와 워크플로우 옵션을 프로그래밍 방식으로 설정
3. **실행** — API 호출로 GSD 페이즈(discuss, plan, execute) 실행
---
## v1.31 기능
### 59. 스키마 드리프트 감지
@@ -1680,7 +1658,7 @@ Claude가 GSD 워크플로우 컨텍스트 밖에서 파일 편집을 시도하
### 74. 컨텍스트 축소
**대상:** GSD SDK 프롬프트 어셈블리
**대상:** 프롬프트 어셈블리 파이프라인
**목적:** Markdown 절삭 및 캐시 친화적 프롬프트 순서를 통해 컨텍스트 프롬프트 크기를 줄입니다.

2
docs/ko-KR/README.md
View File

@@ -12,7 +12,7 @@ Get Shit Done (GSD) 프레임워크의 종합 문서입니다. GSD는 AI 코딩
| [Feature Reference](FEATURES.md) | 전체 사용자 | 요구사항이 포함된 전체 기능 및 함수 문서 |
| [Command Reference](COMMANDS.md) | 전체 사용자 | 모든 명령어의 구문, 플래그, 옵션 및 예제 |
| [Configuration Reference](CONFIGURATION.md) | 전체 사용자 | 전체 설정 스키마, 워크플로우 토글, 모델 프로필, git 브랜칭 |
| [CLI Tools Reference](CLI-TOOLS.md) | 기여자, 에이전트 작성자 | CJS `gsd-tools.cjs` + **`gsd-sdk query`/SDK** 안내 |
| [CLI Tools Reference](CLI-TOOLS.md) | 기여자, 에이전트 작성자 | CJS `gsd-tools.cjs` + `gsd-tools.cjs query` 안내 |
| [Agent Reference](AGENTS.md) | 기여자, 고급 사용자 | 18개 전문 에이전트의 역할, 도구, 스폰 패턴 |
| [User Guide](USER-GUIDE.md) | 전체 사용자 | 워크플로우 안내, 문제 해결, 복구 방법 |
| [Context Monitor](context-monitor.md) | 전체 사용자 | 컨텍스트 윈도우 모니터링 훅 아키텍처 |

2
docs/pt-BR/CLI-TOOLS.md
View File

@@ -1,7 +1,7 @@
# Referência de Ferramentas CLI
Resumo em Português das ferramentas CLI do GSD.
Para API completa (assinaturas, argumentos e comportamento detalhado), consulte [CLI-TOOLS.md em inglês](../CLI-TOOLS.md) — inclui a secção **SDK and programmatic access** (`gsd-sdk query`, `@opengsd/gsd-sdk`).
Para API completa (assinaturas, argumentos e comportamento detalhado), consulte [CLI-TOOLS.md em inglês](../CLI-TOOLS.md) — inclui a secção de uso de `gsd-tools.cjs query`.
---

2
docs/pt-BR/README.md
View File

@@ -12,7 +12,7 @@ Documentação abrangente do framework Get Shit Done (GSD) — um sistema de met
| [Referência de configuração](CONFIGURATION.md) | Todos os usuários | Schema completo de configuração, toggles e perfis |
| [Referência de recursos](FEATURES.md) | Todos os usuários | Recursos e requisitos detalhados |
| [Referência de agentes](AGENTS.md) | Contribuidores, usuários avançados | Agentes especializados, papéis e padrões de orquestração |
| [Ferramentas CLI](CLI-TOOLS.md) | Contribuidores, autores de agentes | Superfície CJS `gsd-tools.cjs` + guia **`gsd-sdk query`/SDK** |
| [Ferramentas CLI](CLI-TOOLS.md) | Contribuidores, autores de agentes | Superfície CJS `gsd-tools.cjs` + guia guia de `gsd-tools.cjs query` |
| [Monitor de contexto](context-monitor.md) | Todos os usuários | Arquitetura de monitoramento da janela de contexto |
| [Discuss Mode](workflow-discuss-mode.md) | Todos os usuários | Modo suposições vs entrevista no `discuss-phase` |
| [Referências](references/) | Todos os usuários | Guias complementares de decisão, verificação e padrões |

12
docs/zh-CN/references/decimal-phase-calculation.md
View File

@@ -2,11 +2,11 @@
为紧急插入计算下一个小数阶段编号。
## 使用 gsd-sdk query
## 使用 gsd-tools.cjs query
```bash
# 获取阶段 6 之后的下一个小数阶段
gsd-sdk query phase.next-decimal 6
gsd-tools.cjs query phase.next-decimal 6
```
输出：
@@ -32,13 +32,13 @@ gsd-sdk query phase.next-decimal 6
## 提取值
```bash
DECIMAL_PHASE=$(gsd-sdk query phase.next-decimal "${AFTER_PHASE}" --pick next)
BASE_PHASE=$(gsd-sdk query phase.next-decimal "${AFTER_PHASE}" --pick base_phase)
DECIMAL_PHASE=$(gsd-tools.cjs query phase.next-decimal "${AFTER_PHASE}" --pick next)
BASE_PHASE=$(gsd-tools.cjs query phase.next-decimal "${AFTER_PHASE}" --pick base_phase)
```
或使用 --raw 标志：
```bash
DECIMAL_PHASE=$(gsd-sdk query phase.next-decimal "${AFTER_PHASE}" --raw)
DECIMAL_PHASE=$(gsd-tools.cjs query phase.next-decimal "${AFTER_PHASE}" --raw)
# 返回: 06.1
```
@@ -56,7 +56,7 @@ DECIMAL_PHASE=$(gsd-sdk query phase.next-decimal "${AFTER_PHASE}" --raw)
小数阶段目录使用完整的小数编号：
```bash
SLUG=$(gsd-sdk query generate-slug "$DESCRIPTION" --raw)
SLUG=$(gsd-tools.cjs query generate-slug "$DESCRIPTION" --raw)
PHASE_DIR=".planning/phases/${DECIMAL_PHASE}-${SLUG}"
mkdir -p "$PHASE_DIR"
```

6
docs/zh-CN/references/git-integration.md
View File

@@ -51,7 +51,7 @@ Phases:
提交内容：
```bash
gsd-sdk query commit "docs: initialize [project-name] ([N] phases)" --files .planning/
gsd-tools.cjs query commit "docs: initialize [project-name] ([N] phases)" --files .planning/
```
</format>
@@ -129,7 +129,7 @@ SUMMARY: .planning/phases/XX-name/{phase}-{plan}-SUMMARY.md
提交内容：
```bash
gsd-sdk query commit "docs({phase}-{plan}): complete [plan-name] plan" --files .planning/phases/XX-name/{phase}-{plan}-PLAN.md .planning/phases/XX-name/{phase}-{plan}-SUMMARY.md .planning/STATE.md .planning/ROADMAP.md
gsd-tools.cjs query commit "docs({phase}-{plan}): complete [plan-name] plan" --files .planning/phases/XX-name/{phase}-{plan}-PLAN.md .planning/phases/XX-name/{phase}-{plan}-SUMMARY.md .planning/STATE.md .planning/ROADMAP.md
```
**注意：** 代码文件不包含 - 已按任务提交。
@@ -149,7 +149,7 @@ Current: [task name]
提交内容：
```bash
gsd-sdk query commit "wip: [phase-name] paused at task [X]/[Y]" --files .planning/
gsd-tools.cjs query commit "wip: [phase-name] paused at task [X]/[Y]" --files .planning/
```
</format>

6
docs/zh-CN/references/git-planning-commit.md
View File

@@ -1,6 +1,6 @@
# Git 规划提交
通过 `gsd-sdk query commit` 提交规划工件，它会自动检查 `commit_docs` 配置和 gitignore 状态（与旧版 `gsd-tools.cjs commit` 行为相同）。
通过 `gsd-tools.cjs query commit` 提交规划工件，它会自动检查 `commit_docs` 配置和 gitignore 状态（与旧版 `gsd-tools.cjs commit` 行为相同）。
## 通过 CLI 提交
@@ -9,7 +9,7 @@
对 `.planning/` 文件始终使用此方式 —— 它会自动处理 `commit_docs` 与 gitignore 检查：
```bash
gsd-sdk query commit "docs({scope}): {description}" --files .planning/STATE.md .planning/ROADMAP.md
gsd-tools.cjs query commit "docs({scope}): {description}" --files .planning/STATE.md .planning/ROADMAP.md
```
如果 `commit_docs` 为 `false` 或 `.planning/` 被 gitignore，CLI 会返回 `skipped`（带原因）。无需手动条件检查。
@@ -19,7 +19,7 @@ gsd-sdk query commit "docs({scope}): {description}" --files .planning/STATE.md .
将 `.planning/` 文件变更合并到上次提交：
```bash
gsd-sdk query commit "" --files .planning/codebase/*.md --amend
gsd-tools.cjs query commit "" --files .planning/codebase/*.md --amend
```
## 提交消息模式

14
docs/zh-CN/references/planning-config.md
View File

@@ -36,19 +36,19 @@
- 用户必须将 `.planning/` 添加到 `.gitignore`
- 适用于：OSS 贡献、客户项目、保持规划私有
**使用 `gsd-sdk query`（推荐）：**
**使用 `gsd-tools.cjs query`（推荐）：**
```bash
# 提交时自动检查 commit_docs + gitignore：
gsd-sdk query commit "docs: update state" --files .planning/STATE.md
gsd-tools.cjs query commit "docs: update state" --files .planning/STATE.md
# 通过 state load 加载配置（返回 JSON）：
INIT=$(gsd-sdk query state.load)
INIT=$(gsd-tools.cjs query state.load)
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
# commit_docs 在 JSON 输出中可用
# 或使用包含 commit_docs 的 init 命令：
INIT=$(gsd-sdk query init.execute-phase "1")
INIT=$(gsd-tools.cjs query init.execute-phase "1")
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
# commit_docs 包含在所有 init 命令输出中
```
@@ -58,7 +58,7 @@ if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
**通过 CLI 提交（自动处理检查）：**
```bash
gsd-sdk query commit "docs: update state" --files .planning/STATE.md
gsd-tools.cjs query commit "docs: update state" --files .planning/STATE.md
```
CLI 在内部检查 `commit_docs` 配置和 gitignore 状态 —— 无需手动条件判断。
@@ -146,14 +146,14 @@ CLI 在内部检查 `commit_docs` 配置和 gitignore 状态 —— 无需手动
使用 `init execute-phase` 返回所有配置为 JSON：
```bash
INIT=$(gsd-sdk query init.execute-phase "1")
INIT=$(gsd-tools.cjs query init.execute-phase "1")
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
# JSON 输出包含：branching_strategy, phase_branch_template, milestone_branch_template
```
或使用 `state load` 获取配置值：
```bash
INIT=$(gsd-sdk query state.load)
INIT=$(gsd-tools.cjs query state.load)
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
# 从 JSON 解析 branching_strategy, phase_branch_template, milestone_branch_template
```