📝 docs: document the aqua install channel (#380)#407
Merged
Conversation
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
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
This was referenced Jul 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-cliworks 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
Changes
README.md—aquarow in the install tabledocs/1.getting-started/1.install.md— a## via aquasectiondocs/fr/1.getting-started/1.install.md— the FR mirror (parity kept: 13 sections each)CHANGELOG.md— entry under[Unreleased]→AddedVerified, not transcribed
Both documented commands were run against the live registry rather than copied out of the aqua docs:
The registry floor is documented, and why
The docs state that standard registry
v4.539.0or newer is required. That number is not a guess:aqua users pin the registry
refin theiraqua.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 failedNo 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.mduse 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** — descriptionseparator, 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
<type>/#<issue>-<description>Verified## [Unreleased]Linked issues / docs