Skip to content

docs: clarify Aqua repository prerequisites #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
konojunya merged 1 commit into from
Sep 5, 2026
Merged

docs: clarify Aqua repository prerequisites #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ stack --version

The package is `stack-diagram-cli`, not the unrelated `stack-cli`; the binary is `stack`. Cargo owns updates and uninstall, and does not automatically install completion or manual files. See [Cargo installation](./docs/distribution.md#cargo-installation).

For Aqua, copy the pinned configuration and policy from the [Aqua installation section](./docs/distribution.md#aqua-installation), review them, allow the policy, and install the checksum-locked package:
For Aqua, copy the pinned configuration and policy from the [Aqua installation section](./docs/distribution.md#aqua-installation) to your Git repository root (run `git init` first for a new project), review them, allow the policy, and install the checksum-locked package:

```sh
aqua policy allow
Expand All @@ -34,7 +34,7 @@ For a direct installation, download the archive for your target and its verifica

## Create your first SVG

After installing, open a new empty working directory and run:
After installing, open a new empty working directory and run the following. With Aqua, keep it inside the Git repository containing your `aqua.yaml`:

```sh
stack --version
Expand Down
4 changes: 2 additions & 2 deletions docs/distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The Homebrew v0.5.1 formula was activated after the immutable release assets wer

The owner registry is the [`aqua/registry.yaml`](../aqua/registry.yaml) file pinned to immutable commit `42702cda91a4156901b9a601bd143c43dcf05766`. Aqua maps `darwin/amd64`, `darwin/arm64`, `linux/amd64`, and `linux/arm64` to the four canonical GitHub Release archives, reads their SHA-256 values from the signed checksum asset, and verifies the checksum bundle against the tagged `release.yaml` workflow identity.

Add the following `aqua.yaml` to a Git repository:
Add the following `aqua.yaml` at the root of a Git repository (the directory containing `.git`). Run `git init` first for a new project:

```yaml
checksum:
Expand All @@ -122,7 +122,7 @@ packages:
registry: stack-sh
```

Because Aqua denies non-standard registries by default, add and review this narrow `aqua-policy.yaml` rather than disabling policy:
Because Aqua denies non-standard registries by default, add and review this narrow `aqua-policy.yaml` at the same repository root rather than disabling policy:

```yaml
registries:
Expand Down
4 changes: 2 additions & 2 deletions skills/docs-source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"repository": "stack-sh/docs",
"revision": "470ec245a4c491ec0e27b717eaea6fab6ade22fd",
"manifestSha256": "856d190ced590cffe4613c4f34276de3cbf3e9f8059b5c323d4247f03bd12bb6"
"revision": "86c51be1ddcabd48b326bacdb6088eb2a2ff79bf",
"manifestSha256": "9e41cdce9df59d8b63e81691cce3da595df206d02c6ed79c7a1adec8e0f6d500"
}