docs: gate unreleased subcommands with v0.21.0+ availability notes#221
Merged
Merged
Conversation
The README on `main` documents `config`, `doctor`, `snapshot`, `record`,
and `view --replay` as if they are current features, but the latest
published release (v0.20.1) does not include any of them — they were
merged after the v0.20.1 tag and are staged for v0.21.0 in the
Changelog. A Windows 11 user who downloaded the v0.20.1 binary and ran
`all-smi.exe config` reasonably (but mistakenly) concluded the problem
was Windows-specific.
Resolve the internal inconsistency between the body sections and the
"v0.21.0 (upcoming)" Changelog entry by adding explicit
"Availability: v0.21.0+" notes to:
- Command Overview (top-of-section banner + per-example tags on
`snapshot`, `record`, and `view --replay`)
- Configuration (covers `config init`, `config print`,
`config validate`, and the TOML loader)
- Diagnostics (`doctor`)
- Scripting / CI (Snapshot Mode) (`snapshot`)
- Recording & Replay (`record` and `view --replay`)
Each note points users to building from source or waiting for the
v0.21.0 release. Environment-variable behaviour that already worked in
v0.20.1 is called out explicitly in the Configuration banner so users
do not assume those broke.
Also reconcile four `github.com/inureyes/all-smi/...` links in the
Debian package and pre-built binary install sections to the canonical
`lablup/all-smi` repository, matching the upstream releases page that
the body actually points users toward.
No source change is required; the subcommands themselves already exist
on `main` and will ship as documented in v0.21.0.
inureyes
added a commit
that referenced
this pull request
May 24, 2026
Refs #221, #222, #224, #225, #226, #227. Align config path active discovery with the implicit loader's first-existing-candidate semantics, correct record output help and resolver docs against the binary default, and make the swap-color regression test derive crossterm's current Red SGR sequence instead of hard-coding older encodings.
inureyes
added a commit
that referenced
this pull request
May 24, 2026
Refs #221, #222, #224, #225, #226, #227. Align config path active discovery with the implicit loader's first-existing-candidate semantics, correct record output help and resolver docs against the binary default, and make the swap-color regression test derive crossterm's current Red SGR sequence instead of hard-coding older encodings.
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
1 participant
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.
Summary
Resolves the README inconsistency reported in #214: the body presented
config,doctor,snapshot,record, andview --replayas currently-shipped features, while the Changelog correctly listed them under "v0.21.0 (upcoming)". A Windows 11 user on v0.20.1 followed the README, ranall-smi.exe config, hiterror: unrecognized subcommand 'config', and reasonably concluded the bug was Windows-specific — it is not; these subcommands are absent on every platform in v0.20.1 because they post-date the tag.This PR takes option 2 from the issue ("version-gate the docs"). Option 1 (cutting v0.21.0) is out of scope for
/auto-impl.Changes
README.mdonly — no source changes; the subcommands already exist onmainand ship as documented in v0.21.0.mainand tagging each of the four unreleased examples (snapshot,record,view --replay) with(Availability: v0.21.0+)inline.config init / print / validatehelpers and the TOML loader, explicitly calling out that pre-existing environment variables (e.g.,ALL_SMI_API_PORT,ALL_SMI_ALERTS_TEMP_WARN_C) continue to work in v0.20.1 so users do not assume those regressed.doctorsubcommand.snapshotsubcommand.recordandview --replay.github.com/inureyes/all-smi/...links in the Debian package and pre-built binary install sections to the canonicallablup/all-smirepository (secondary cleanup noted in the issue).Wording was kept consistent with the Changelog's existing "v0.21.0 (upcoming)" entry so the two sources of truth agree.
Test plan
cargo check --lib --testspasses (docs-only change; verifies no inadvertent breakage)grep -n "Availability: v0.21" README.mdshows 8 hits (1 banner + 3 inline tags in Command Overview, plus 1 banner each in Configuration, Diagnostics, Snapshot, and Recording & Replay)grep -n "inureyes/all-smi" README.mdreturns empty (no residual upstream URL drift)config,doctor,snapshot,record, orview --replaynow agrees with the Changelog's "v0.21.0 (upcoming)" entryCloses #214