Skip to content

docs(install): warn about multiple distribution channels (#314)#320

Merged
ajianaz merged 1 commit into
developfrom
docs/314-install-path-conflicts
Jun 17, 2026
Merged

docs(install): warn about multiple distribution channels (#314)#320
ajianaz merged 1 commit into
developfrom
docs/314-install-path-conflicts

Conversation

@ajianaz

@ajianaz ajianaz commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes #314 — install instructions don't warn about multiple distribution channels causing PATH conflicts.

The install docs listed several methods (installer script, cargo, pre-built binaries, npm) without warning that having more than one on $PATH silently resolves to whichever appears first. On a real developer machine three copies were present simultaneously (~/.local/bin/cora, ~/.cargo/bin/cora, ~/.bun/bin/cora) and the stale npm v0.2.4 was being invoked, causing confusing behavior with no warning.

Closes #315 as a duplicate of #314 (same title, body, author, opened 3 seconds apart — already closed on the issue tracker).

Changes

README.md — Install section

CHANGELOG.md

Entry under ## [0.6.1] -> Changed — Docs.

Tests

Docs-only change. cargo build and cargo fmt --check still pass to keep the version bump consistent with the rest of the 0.6.1 patch bundle.

Versioning

Patch bump 0.6.00.6.1 (shares the release with #316, #312, #313).

⚠️ Merge note: CHANGELOG and Cargo.toml will conflict with #317, #318, and #319. Suggested merge order: #317#318#319this PR (docs last). Conflicts are confined to the ## [0.6.1] block of CHANGELOG.md and the version line in Cargo.toml/Cargo.lock.

Checklist

The install docs listed several methods without warning that having more\nthan one on $PATH silently resolves to whichever appears first. On a real\ndeveloper machine three copies were present simultaneously\n(~/.local/bin, ~/.cargo/bin, ~/.bun/bin) and the stale npm v0.2.4 was\nbeing invoked, causing confusing behavior.\n\nChanges\n- README: pick one recommended method, list all supported channels in a\n  table, and add a `which -a cora && cora --version` check snippet with\n  guidance for pruning stale copies.\n- Cross-link issue #314 for background.\n- CHANGELOG entry under ## [0.6.1] -> Changed — Docs.\n\nAlso closes #315 as a duplicate of #314 (same title/body/author, opened\n3 seconds apart).\n\nBump 0.6.0 -> 0.6.1 (patch; docs only).
@ajianaz ajianaz force-pushed the docs/314-install-path-conflicts branch from 8a70b0a to 25ea336 Compare June 17, 2026 06:30
@ajianaz ajianaz merged commit d026db6 into develop Jun 17, 2026
10 checks passed
@ajianaz ajianaz deleted the docs/314-install-path-conflicts branch June 17, 2026 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant