Skip to content

📝 docs: document the aqua install channel (#380)#407

Merged
kbrdn1 merged 1 commit into
devfrom
docs/#380-aqua-install-docs
Jul 20, 2026
Merged

📝 docs: document the aqua install channel (#380)#407
kbrdn1 merged 1 commit into
devfrom
docs/#380-aqua-install-docs

Conversation

@kbrdn1

@kbrdn1 kbrdn1 commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Description

aquaproj/aqua-registry#57117 merged on 2026-07-17, so gwm is now in the aqua standard registry and aqua g -i kbrdn1/gwm-cli works today. This documents the channel.

It was deliberately left undocumented while the upstream PR was open: an install command that 404s is worse than no install command at all.

Closes #380

Type of change

  • 📝 Documentation

Changes

  • README.mdaqua row in the install table
  • docs/1.getting-started/1.install.md — a ## via aqua section
  • docs/fr/1.getting-started/1.install.md — the FR mirror (parity kept: 13 sections each)
  • CHANGELOG.md — entry under [Unreleased]Added

Verified, not transcribed

Both documented commands were run against the live registry rather than copied out of the aqua docs:

$ aqua i            # aqua.yaml pinned to standard registry v4.539.0
INF create a symbolic link  package_name=kbrdn1/gwm-cli package_version=v1.1.1 command=gwm
$ aqua exec -- gwm --version
gwm 1.1.1

$ aqua g -i kbrdn1/gwm-cli
# aqua.yaml now contains:  - name: kbrdn1/gwm-cli@v1.1.1

The registry floor is documented, and why

The docs state that standard registry v4.539.0 or newer is required. That number is not a guess:

v4.539.0 → pkgs/kbrdn1/gwm-cli/registry.yaml  200
v4.538.1 → pkgs/kbrdn1/gwm-cli/registry.yaml  404

aqua users pin the registry ref in their aqua.yaml, so anyone on an older pin gets an unknown package error rather than an install. That error is the first thing they would search for, so the fix belongs in the section rather than in an issue later.

Tests

  • cargo test — 1972 passed, 0 failed

No test added: this is prose in Markdown with no observable behaviour to pin, which is the TDD exception argued per CLAUDE.md. I checked that nothing asserts these files' contents — the test files that mention README.md use it as a fixture inside temporary repos, not as an assertion about ours.

Note on style

The prose avoids em dashes per the repo's writing preference. The CHANGELOG entry keeps the **Title** — description separator, because that is the established structural format of the five sibling entries directly above it and breaking it for one entry would look like a mistake. Say the word if you would rather it be uniform.

Checklist

  • Branch follows <type>/#<issue>-<description>
  • Commits follow Gitmoji + Conventional Commits
  • Commits are Verified
  • CHANGELOG.md updated under ## [Unreleased]
  • Docs updated in both EN and FR

Linked issues / docs

aquaproj/aqua-registry#57117 merged, so gwm is in the aqua standard registry
and `aqua g -i kbrdn1/gwm-cli` works today. Documenting it now that it does:
the channel was deliberately left undocumented while the upstream PR was open,
since an install command that 404s is worse than no install command.

README table row, an EN section plus its FR mirror, and a CHANGELOG entry
under [Unreleased] > Added.

Both commands were verified against the live registry rather than transcribed
from the aqua docs: `aqua i` off a pinned `aqua.yaml` and `aqua g -i` both
installed gwm 1.1.1 and `aqua exec -- gwm --version` printed `gwm 1.1.1`.

The docs state the registry floor (`v4.539.0`), established by checking that
the package resolves at that ref and 404s at v4.538.1 — a user pinned to an
older `ref` gets an unknown-package error, and that is the first thing they
will search for.

closes #380
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 78768440-18f5-4fe4-a153-a2bba25f29d9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/#380-aqua-install-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@kbrdn1
kbrdn1 merged commit b632bca into dev Jul 20, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant