docs: fix binary install location documentation#42
Merged
Conversation
Binary installs to <package>/bin/ first, with ~/.capiscio/bin as fallback when package dir is read-only. Download is lazy (no postinstall). Docs previously only documented the fallback path. Fixes: DOCS_REMEDIATION_PLAN P2-9
There was a problem hiding this comment.
Pull request overview
Updates end-user documentation to describe where the wrapper installs/caches the capiscio-core binary, aligning docs with the wrapper’s runtime download behavior.
Changes:
- Updated docs to describe a primary install location under the package directory with a home-directory fallback.
- Clarified that downloads happen lazily on first command (no
postinstall).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/index.md | Updates the high-level “What this package does” description of binary caching and first-run download behavior. |
| docs/getting-started/installation.md | Updates installation guide language and lists primary/fallback binary locations. |
| README.md | Updates “How it Works” section to describe primary/fallback binary locations and lazy download behavior. |
| - **macOS/Linux**: `~/.capiscio/bin/` | ||
| - **Windows**: `%USERPROFILE%\.capiscio\bin\` | ||
| - **Primary**: `<package>/bin/capiscio` (alongside node_modules) | ||
| - **Fallback**: `~/.capiscio/bin/capiscio` (if package dir is read-only) |
Comment on lines
+59
to
+61
| - **Primary**: `<package>/bin/capiscio` (alongside node_modules) | ||
| - **Fallback**: `~/.capiscio/bin/capiscio` (if package dir is read-only) | ||
| - *Windows fallback*: `%USERPROFILE%\.capiscio\bin` |
|
|
||
| 1. **Downloads** the correct `capiscio-core` binary for your platform (macOS/Linux/Windows, AMD64/ARM64) | ||
| 2. **Caches** the binary in `~/.capiscio/bin` (or `%USERPROFILE%\.capiscio\bin` on Windows) | ||
| 2. **Caches** the binary in `<package>/bin/` (primary) or `~/.capiscio/bin` (fallback if package dir is read-only) |
Comment on lines
+47
to
+49
| - **Primary**: `<package>/bin/capiscio` (alongside node_modules) | ||
| - **Fallback**: `~/.capiscio/bin/capiscio` (if package dir is read-only) | ||
| - **Windows fallback**: `%USERPROFILE%\.capiscio\bin\` |
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
Fixes incorrect binary install location in documentation.
Issues Fixed
Changes