Fix docs: use crates/matchy for cargo install --path#57
Open
J-Gras wants to merge 1 commit intomatchylabs:mainfrom
Open
Fix docs: use crates/matchy for cargo install --path#57J-Gras wants to merge 1 commit intomatchylabs:mainfrom
J-Gras wants to merge 1 commit intomatchylabs:mainfrom
Conversation
Root Cargo.toml is a workspace manifest; cargo install requires a package path.
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
Fix documentation for installing the CLI from source. The repo root
Cargo.tomlis a workspace manifest (no[package]), socargo install --path .fails with "found a virtual manifest ... instead of a package manifest". The docs now usecargo install --path crates/matchy, which installs the matchy binary from the main crate.Updated:
book/src/getting-started/installation.md– "From source" sectionbook/src/getting-started/cli-installation.md– "Installing from source" sectionbook/src/dev/building.md– "Quick Build" / Install CLI stepFixes # (issue)
Type of Change
How Has This Been Tested?
cargo test)cargo bench)(Docs-only change; verified install command works from repo root.)
Checklist
cargo fmt)cargo clippy)Performance Impact
N/A – documentation only.
Breaking Changes
None.
Additional Context
.github/workflows/deploy-docs.ymlcorrectly usescargo install --path .from insidebook/mdbook-project-version(a separate package); no change there.