From 59d0a60c4bb48e1e03e060003e98eb157107f154 Mon Sep 17 00:00:00 2001 From: konojunya Date: Sun, 6 Sep 2026 06:24:26 +0900 Subject: [PATCH 1/2] docs: clarify the Git root required for Aqua policy discovery --- content/site/guide/getting-started.md | 2 +- content/site/ja/guide/getting-started.md | 2 +- content/site/ko/guide/getting-started.md | 2 +- content/site/zh/guide/getting-started.md | 2 +- generated/manifest.json | 8 ++++---- generated/site/guide/getting-started.md | 2 +- generated/site/ja/guide/getting-started.md | 2 +- generated/site/ko/guide/getting-started.md | 2 +- generated/site/zh/guide/getting-started.md | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/content/site/guide/getting-started.md b/content/site/guide/getting-started.md index c2f0467..2730b0e 100644 --- a/content/site/guide/getting-started.md +++ b/content/site/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked ### Aqua -In a Git repository, save the following as `aqua.yaml`: +At the root of a Git repository (the directory containing `.git`), save the following as `aqua.yaml`. If this is a new project, run `git init` first: ```yaml checksum: diff --git a/content/site/ja/guide/getting-started.md b/content/site/ja/guide/getting-started.md index 560d407..22face5 100644 --- a/content/site/ja/guide/getting-started.md +++ b/content/site/ja/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked ### Aqua -Gitリポジトリ内に、次の内容を`aqua.yaml`として保存します。 +Gitリポジトリのルート(`.git`があるディレクトリ)に、次の内容を`aqua.yaml`として保存します。新しいプロジェクトでは先に`git init`を実行してください。 ```yaml checksum: diff --git a/content/site/ko/guide/getting-started.md b/content/site/ko/guide/getting-started.md index 55f3348..a6f94e8 100644 --- a/content/site/ko/guide/getting-started.md +++ b/content/site/ko/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked ### Aqua -Git 저장소에서 다음 내용을 `aqua.yaml`로 저장하세요. +Git 저장소의 루트(`.git`이 있는 디렉터리)에 다음 내용을 `aqua.yaml`로 저장하세요. 새 프로젝트라면 먼저 `git init`을 실행하세요. ```yaml checksum: diff --git a/content/site/zh/guide/getting-started.md b/content/site/zh/guide/getting-started.md index d7fb8b7..fed3872 100644 --- a/content/site/zh/guide/getting-started.md +++ b/content/site/zh/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked ### Aqua -在Git仓库中,将以下内容保存为`aqua.yaml`: +在Git仓库的根目录(包含`.git`的目录)中,将以下内容保存为`aqua.yaml`。新项目请先运行`git init`: ```yaml checksum: diff --git a/generated/manifest.json b/generated/manifest.json index 5edad9e..bc55ab2 100644 --- a/generated/manifest.json +++ b/generated/manifest.json @@ -24,7 +24,7 @@ }, { "path": "site/guide/getting-started.md", - "sha256": "a6001affc631efa8e52c37b80eee3d4228f255c934e6564266e7ae613bae9322" + "sha256": "d1ecf1c7bb8c6044ea0235b85cb4f982b4150e942eb7c93e7314eb66df8ab92b" }, { "path": "site/guide/playground.md", @@ -52,7 +52,7 @@ }, { "path": "site/ja/guide/getting-started.md", - "sha256": "10838a254fce97b88a304bd1cdf8940c3f3522fdecb37428cea36cee0b35e978" + "sha256": "28bdbb9838e2f181d2f19b21f9fdab7d440b70aadd72f9e3064243fe23991758" }, { "path": "site/ja/guide/playground.md", @@ -108,7 +108,7 @@ }, { "path": "site/ko/guide/getting-started.md", - "sha256": "e8c3980411457ed25973fe2075c6d58f22d9c5b17aeadfaecd73d9d4e91f257f" + "sha256": "5b0b398c0e62ed9c7f53f685e42facd4de71cc3a362c8c359b6284b26771b432" }, { "path": "site/ko/guide/playground.md", @@ -192,7 +192,7 @@ }, { "path": "site/zh/guide/getting-started.md", - "sha256": "0741c92878eeff3b378f229f99ebadcb98689d13f6458644e4523e6b46cf923b" + "sha256": "f229319cf56bca7b5489b7fcf8a1cd058dfe586acf691714a5e1a69e6d63b46c" }, { "path": "site/zh/guide/playground.md", diff --git a/generated/site/guide/getting-started.md b/generated/site/guide/getting-started.md index ced5fc6..35c52ae 100644 --- a/generated/site/guide/getting-started.md +++ b/generated/site/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked ### Aqua -In a Git repository, save the following as `aqua.yaml`: +At the root of a Git repository (the directory containing `.git`), save the following as `aqua.yaml`. If this is a new project, run `git init` first: ```yaml checksum: diff --git a/generated/site/ja/guide/getting-started.md b/generated/site/ja/guide/getting-started.md index 6dcde83..3b75cfe 100644 --- a/generated/site/ja/guide/getting-started.md +++ b/generated/site/ja/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked ### Aqua -Gitリポジトリ内に、次の内容を`aqua.yaml`として保存します。 +Gitリポジトリのルート(`.git`があるディレクトリ)に、次の内容を`aqua.yaml`として保存します。新しいプロジェクトでは先に`git init`を実行してください。 ```yaml checksum: diff --git a/generated/site/ko/guide/getting-started.md b/generated/site/ko/guide/getting-started.md index 9683686..2d27904 100644 --- a/generated/site/ko/guide/getting-started.md +++ b/generated/site/ko/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked ### Aqua -Git 저장소에서 다음 내용을 `aqua.yaml`로 저장하세요. +Git 저장소의 루트(`.git`이 있는 디렉터리)에 다음 내용을 `aqua.yaml`로 저장하세요. 새 프로젝트라면 먼저 `git init`을 실행하세요. ```yaml checksum: diff --git a/generated/site/zh/guide/getting-started.md b/generated/site/zh/guide/getting-started.md index fd31c8d..5721a44 100644 --- a/generated/site/zh/guide/getting-started.md +++ b/generated/site/zh/guide/getting-started.md @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked ### Aqua -在Git仓库中,将以下内容保存为`aqua.yaml`: +在Git仓库的根目录(包含`.git`的目录)中,将以下内容保存为`aqua.yaml`。新项目请先运行`git init`: ```yaml checksum: From 0b6bf3cb943519e89168c189efc577b233629e45 Mon Sep 17 00:00:00 2001 From: konojunya Date: Sun, 6 Sep 2026 06:25:04 +0900 Subject: [PATCH 2/2] docs: keep the Aqua walkthrough inside its project --- content/site/guide/getting-started.md | 2 +- content/site/ja/guide/getting-started.md | 2 +- content/site/ko/guide/getting-started.md | 2 +- content/site/zh/guide/getting-started.md | 2 +- generated/manifest.json | 8 ++++---- generated/site/guide/getting-started.md | 2 +- generated/site/ja/guide/getting-started.md | 2 +- generated/site/ko/guide/getting-started.md | 2 +- generated/site/zh/guide/getting-started.md | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/content/site/guide/getting-started.md b/content/site/guide/getting-started.md index 2730b0e..172546e 100644 --- a/content/site/guide/getting-started.md +++ b/content/site/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## Create your first SVG -In a new empty working directory, run: +In a new empty working directory, run the following. With Aqua, keep this directory inside the Git repository containing your `aqua.yaml`: ```sh $ stack --version diff --git a/content/site/ja/guide/getting-started.md b/content/site/ja/guide/getting-started.md index 22face5..65f77b3 100644 --- a/content/site/ja/guide/getting-started.md +++ b/content/site/ja/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 最初のSVGを作る -新しい空の作業ディレクトリで実行します。 +新しい空の作業ディレクトリで実行します。Aquaを使う場合は、`aqua.yaml`があるGitリポジトリの内側に作ってください。 ```sh $ stack --version diff --git a/content/site/ko/guide/getting-started.md b/content/site/ko/guide/getting-started.md index a6f94e8..9cbfc99 100644 --- a/content/site/ko/guide/getting-started.md +++ b/content/site/ko/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 첫 SVG 만들기 -새로운 빈 작업 디렉터리에서 실행하세요. +새로운 빈 작업 디렉터리에서 실행하세요. Aqua를 사용한다면 `aqua.yaml`이 있는 Git 저장소 안에 디렉터리를 만드세요. ```sh $ stack --version diff --git a/content/site/zh/guide/getting-started.md b/content/site/zh/guide/getting-started.md index fed3872..0c5f794 100644 --- a/content/site/zh/guide/getting-started.md +++ b/content/site/zh/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 生成第一个SVG -在新的空工作目录中执行: +在新的空工作目录中执行。使用Aqua时,请将该目录放在包含`aqua.yaml`的Git仓库内: ```sh $ stack --version diff --git a/generated/manifest.json b/generated/manifest.json index bc55ab2..fd8e67c 100644 --- a/generated/manifest.json +++ b/generated/manifest.json @@ -24,7 +24,7 @@ }, { "path": "site/guide/getting-started.md", - "sha256": "d1ecf1c7bb8c6044ea0235b85cb4f982b4150e942eb7c93e7314eb66df8ab92b" + "sha256": "b9e21a3fcf5c8de6360dcf060cbf2b05099f0e55dda1186f1ea3700740e0a860" }, { "path": "site/guide/playground.md", @@ -52,7 +52,7 @@ }, { "path": "site/ja/guide/getting-started.md", - "sha256": "28bdbb9838e2f181d2f19b21f9fdab7d440b70aadd72f9e3064243fe23991758" + "sha256": "bae22b095cc22279e48494213748d1b0413eddec9893b261c73159267c27875d" }, { "path": "site/ja/guide/playground.md", @@ -108,7 +108,7 @@ }, { "path": "site/ko/guide/getting-started.md", - "sha256": "5b0b398c0e62ed9c7f53f685e42facd4de71cc3a362c8c359b6284b26771b432" + "sha256": "0e55e18cc77bfa6ffb2598ecfc69b1884a8e0380e54953860cbfa1e01ebcd58b" }, { "path": "site/ko/guide/playground.md", @@ -192,7 +192,7 @@ }, { "path": "site/zh/guide/getting-started.md", - "sha256": "f229319cf56bca7b5489b7fcf8a1cd058dfe586acf691714a5e1a69e6d63b46c" + "sha256": "88100e9090603b3eb07fad7e7b32f066cede0cfcc306e28ecb4ed852b9a850e1" }, { "path": "site/zh/guide/playground.md", diff --git a/generated/site/guide/getting-started.md b/generated/site/guide/getting-started.md index 35c52ae..c5c57c6 100644 --- a/generated/site/guide/getting-started.md +++ b/generated/site/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## Create your first SVG -In a new empty working directory, run: +In a new empty working directory, run the following. With Aqua, keep this directory inside the Git repository containing your `aqua.yaml`: ```sh $ stack --version diff --git a/generated/site/ja/guide/getting-started.md b/generated/site/ja/guide/getting-started.md index 3b75cfe..739368d 100644 --- a/generated/site/ja/guide/getting-started.md +++ b/generated/site/ja/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 最初のSVGを作る -新しい空の作業ディレクトリで実行します。 +新しい空の作業ディレクトリで実行します。Aquaを使う場合は、`aqua.yaml`があるGitリポジトリの内側に作ってください。 ```sh $ stack --version diff --git a/generated/site/ko/guide/getting-started.md b/generated/site/ko/guide/getting-started.md index 2d27904..0676f47 100644 --- a/generated/site/ko/guide/getting-started.md +++ b/generated/site/ko/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 첫 SVG 만들기 -새로운 빈 작업 디렉터리에서 실행하세요. +새로운 빈 작업 디렉터리에서 실행하세요. Aqua를 사용한다면 `aqua.yaml`이 있는 Git 저장소 안에 디렉터리를 만드세요. ```sh $ stack --version diff --git a/generated/site/zh/guide/getting-started.md b/generated/site/zh/guide/getting-started.md index 5721a44..e5a5220 100644 --- a/generated/site/zh/guide/getting-started.md +++ b/generated/site/zh/guide/getting-started.md @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH" ## 生成第一个SVG -在新的空工作目录中执行: +在新的空工作目录中执行。使用Aqua时,请将该目录放在包含`aqua.yaml`的Git仓库内: ```sh $ stack --version