From 610ebdebe865ffb3cfd2c30f5441810869e5ccd7 Mon Sep 17 00:00:00 2001 From: Tom Boucher Date: Thu, 6 Aug 2026 10:56:53 -0400 Subject: [PATCH] docs(#3043): add caution blocks for --dangerously-skip-permissions (#3121) * docs(#3043): add caution blocks for --dangerously-skip-permissions The flag was presented without a caveat in docs/USER-GUIDE.md, docs/tutorials/onboarding-an-existing-codebase.md, and all four translated locales. Only the English first-project tutorial carried a proper [!CAUTION] block. All 10 uncaveated occurrences now carry the same caution block (optional flag, throwaway/low-stakes use, how to keep confirmations, link to security model). * chore(#3043): backfill changeset PR number 3121 --------- Co-authored-by: sim --- .changeset/steady-seals-march.md | 5 +++++ docs/USER-GUIDE.md | 7 +++++++ docs/ja-JP/USER-GUIDE.md | 7 +++++++ docs/ja-JP/tutorials/onboarding-an-existing-codebase.md | 7 +++++++ docs/ko-KR/USER-GUIDE.md | 7 +++++++ docs/ko-KR/tutorials/onboarding-an-existing-codebase.md | 7 +++++++ docs/pt-BR/USER-GUIDE.md | 7 +++++++ docs/pt-BR/tutorials/onboarding-an-existing-codebase.md | 7 +++++++ docs/tutorials/onboarding-an-existing-codebase.md | 7 +++++++ docs/zh-CN/USER-GUIDE.md | 7 +++++++ docs/zh-CN/tutorials/onboarding-an-existing-codebase.md | 7 +++++++ 11 files changed, 75 insertions(+) create mode 100644 .changeset/steady-seals-march.md diff --git a/.changeset/steady-seals-march.md b/.changeset/steady-seals-march.md new file mode 100644 index 000000000..c38ec86df --- /dev/null +++ b/.changeset/steady-seals-march.md @@ -0,0 +1,5 @@ +--- +type: Fixed +pr: 3121 +--- +**Documentation now consistently warns about `--dangerously-skip-permissions`** — the flag was presented without a caveat in the user guide, the onboarding tutorial, and all four translated locales (ja-JP, zh-CN, ko-KR, pt-BR), while the English first-project tutorial carried a proper caution. All occurrences now carry the same `[!CAUTION]` block. (#3043) diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index f0c87ea1e..36b06f66c 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -524,6 +524,13 @@ claude --dangerously-skip-permissions /gsd-pause-work --report # Generate session summary ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + ### New Project from Existing Document ```bash diff --git a/docs/ja-JP/USER-GUIDE.md b/docs/ja-JP/USER-GUIDE.md index b8956005e..1a1f09677 100644 --- a/docs/ja-JP/USER-GUIDE.md +++ b/docs/ja-JP/USER-GUIDE.md @@ -458,6 +458,13 @@ claude --dangerously-skip-permissions /gsd-pause-work --report # Generate session summary ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + ### 既存ドキュメントからの新規プロジェクト ```bash diff --git a/docs/ja-JP/tutorials/onboarding-an-existing-codebase.md b/docs/ja-JP/tutorials/onboarding-an-existing-codebase.md index 8a730dc98..8241997ce 100644 --- a/docs/ja-JP/tutorials/onboarding-an-existing-codebase.md +++ b/docs/ja-JP/tutorials/onboarding-an-existing-codebase.md @@ -42,6 +42,13 @@ npx @opengsd/gsd-core@latest claude --dangerously-skip-permissions ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + --- ## ステップ 3 — Brownfield オンボーディングの開始 diff --git a/docs/ko-KR/USER-GUIDE.md b/docs/ko-KR/USER-GUIDE.md index 14a739c31..a900a85d6 100644 --- a/docs/ko-KR/USER-GUIDE.md +++ b/docs/ko-KR/USER-GUIDE.md @@ -463,6 +463,13 @@ claude --dangerously-skip-permissions /gsd-pause-work --report # Generate session summary ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + ### 기존 문서로 새 프로젝트 ```bash diff --git a/docs/ko-KR/tutorials/onboarding-an-existing-codebase.md b/docs/ko-KR/tutorials/onboarding-an-existing-codebase.md index 6fe4b7c51..468e78b44 100644 --- a/docs/ko-KR/tutorials/onboarding-an-existing-codebase.md +++ b/docs/ko-KR/tutorials/onboarding-an-existing-codebase.md @@ -42,6 +42,13 @@ npx @opengsd/gsd-core@latest claude --dangerously-skip-permissions ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + --- ## Step 3 — 브라운필드 온보딩 시작 diff --git a/docs/pt-BR/USER-GUIDE.md b/docs/pt-BR/USER-GUIDE.md index ef0b5af6a..9934013ff 100644 --- a/docs/pt-BR/USER-GUIDE.md +++ b/docs/pt-BR/USER-GUIDE.md @@ -463,6 +463,13 @@ claude --dangerously-skip-permissions /gsd-pause-work --report # Generate session summary ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + ### Novo projeto a partir de um documento existente ```bash diff --git a/docs/pt-BR/tutorials/onboarding-an-existing-codebase.md b/docs/pt-BR/tutorials/onboarding-an-existing-codebase.md index 4e8a99c76..ddc5c5a82 100644 --- a/docs/pt-BR/tutorials/onboarding-an-existing-codebase.md +++ b/docs/pt-BR/tutorials/onboarding-an-existing-codebase.md @@ -42,6 +42,13 @@ Escolha **Claude Code** e **local** quando solicitado. Você verá: claude --dangerously-skip-permissions ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + --- ## Passo 3 — Iniciar o onboarding brownfield diff --git a/docs/tutorials/onboarding-an-existing-codebase.md b/docs/tutorials/onboarding-an-existing-codebase.md index fd6774ee4..a4deb5459 100644 --- a/docs/tutorials/onboarding-an-existing-codebase.md +++ b/docs/tutorials/onboarding-an-existing-codebase.md @@ -42,6 +42,13 @@ Choose **Claude Code** and **local** when prompted. You'll see: claude --dangerously-skip-permissions ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + --- ## Step 3 — Start brownfield onboarding diff --git a/docs/zh-CN/USER-GUIDE.md b/docs/zh-CN/USER-GUIDE.md index 0bfb4af22..436ce677d 100644 --- a/docs/zh-CN/USER-GUIDE.md +++ b/docs/zh-CN/USER-GUIDE.md @@ -462,6 +462,13 @@ claude --dangerously-skip-permissions /gsd-pause-work --report # Generate session summary ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + ### 从现有文档新建项目 ```bash diff --git a/docs/zh-CN/tutorials/onboarding-an-existing-codebase.md b/docs/zh-CN/tutorials/onboarding-an-existing-codebase.md index b90522443..256e2378f 100644 --- a/docs/zh-CN/tutorials/onboarding-an-existing-codebase.md +++ b/docs/zh-CN/tutorials/onboarding-an-existing-codebase.md @@ -42,6 +42,13 @@ npx @opengsd/gsd-core@latest claude --dangerously-skip-permissions ``` +> [!CAUTION] +> **The permissions flag is optional.** It skips per-file confirmation while +> GSD's sub-agents read and write files. Use it only in low-stakes or +> throwaway contexts. To keep confirmations enabled, start with `claude` instead. +> For real work, read the [security model](../explanation/security-model.md) first. + + --- ## 第 3 步 — 开始 brownfield onboarding