docs: explain how to find the release version instead of pinning it#6
Merged
Conversation
…REPORT-77] Rather than hardcode a version into the install instructions (which would go stale and need updating every release), tell readers how to find the current version on the Releases page and how the asset filenames are constructed: - macOS direct download: grab the asset ending in _darwin_arm64/amd64.tar.gz. - Linux direct download: a VERSION variable plus the cc-data_<version>_<os>_<arch>.tar.gz pattern. No version-specific edits are needed on future releases.
dougmartin
force-pushed
the
REPORT-77-doc-version-0-1-0
branch
from
July 22, 2026 17:59
be7635a to
0cce951
Compare
dougmartin
changed the title
There was a problem hiding this comment.
Pull request overview
Updates the researcher guide’s direct-download instructions to be version-agnostic by guiding readers to determine the current release version (or select the correct asset) from GitHub Releases, reducing the need for per-release doc edits.
Changes:
- macOS (no Homebrew): instructs users to pick the correct asset by suffix (
_darwin_arm64vs_darwin_amd64) from the latest release. - Linux direct download: documents the release asset naming pattern and uses a
VERSIONvariable in the download command.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…RT-77] Address the Copilot review: the snippet used VERSION=0.1.0 labeled 'the current version', which invites blind copy-paste of a version that ages. Use X.Y.Z so an unedited copy fails loudly (a 404) instead of silently installing an old build.
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.
Summary
Makes the researcher guide's direct-download instructions version-agnostic instead of pinning a version, so they never go stale and never need a per-release edit.
Hardcoding a version means every release needs a doc update that's easy to forget. Instead, the guide now tells readers how to find the current version and how the asset names are built:
Changes
_darwin_arm64.tar.gz(Apple Silicon) or_darwin_amd64.tar.gz(Intel), no version to type.cc-data_<version>_<os>_<arch>.tar.gzpattern and uses a singleVERSIONvariable the reader sets from the Releases page.The only version numbers remaining are clearly-labeled illustrative examples; there is no hardcoded download URL.