Fix #1540: fix:#1878
Open
Memtensor-AI wants to merge 1 commit into
Open
Conversation
…1540) The README's 'Quick start' section told users to use install.sh instead of npm install, but the warning was buried and users still tried 'npm install -g @memtensor/memos-local-plugin' first. The reporter in #1540 encountered this on a Hermes deployment. This change: - Promotes the 'do not run npm install -g' notice to a prominent IMPORTANT callout explaining why global install is wrong (no agent-home deploy, no config.yaml, no bridge/viewer) and that the tarball intentionally ships built artifacts only. - Adds a Troubleshooting subsection covering the two specific symptoms in the bug report: the 'package not found' misread, and the stale web/ and site/ directory names (web/ is now viewer/, site/ was removed by commit 26e7e3d). - Mentions install.ps1 for Windows alongside install.sh. - CHANGELOG: record the docs fix and reference #1540. Documentation-only change; no code or runtime behavior touched.
Memtensor-AI
requested review from
CarltonXiang,
MatthewZhuang and
syzsunshine219
Collaborator
Author
✅ Automated Test Results: PASSEDAll tests passed (35/-542 executed, 613 skipped). memos_local_plugin/smoke: 0 passed, 578 skipped, memos_local_plugin/contract: 35 passed, 35 skipped. Duration: 4s Branch: |
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
4 participants
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
Fixed issue #1540 by updating the memos-local-plugin documentation to clarify the correct installation method and explain the confusion around web/ and site/ directories.
What was fixed
The issue reported two problems:
npm install -g @memtensor/memos-local-pluginwhich failed or didn't work as expectedRoot cause
The documentation didn't prominently explain that this package is a plugin, not a standalone CLI, and requires the install.sh script for proper deployment. Additionally, commit 26e7e3d renamed web/ to viewer/ and removed site/, but users looking at published tarballs or old documentation were confused.
Changes made
README.md: Added a prominent IMPORTANT callout in the Quick start section explaining:
npm install -gis wrong (doesn't deploy to agent home, no config.yaml, no bridge/viewer)README.md: Added a Troubleshooting subsection with two FAQs:
README.md: Mentioned install.ps1 for Windows users alongside install.sh
CHANGELOG.md: Documented this fix as version 2.0.6 (unreleased) referencing issue fix: #1540
Verification
This is a documentation-only change with no code or runtime behavior modifications. The changes directly address both confusion points raised in issue #1540.
Related Issue (Required): Fixes #1540
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Executor did not report tests.
Checklist
@MatthewZhuang, @CarltonXiang, @syzsunshine219 please review this PR.
Reviewer Checklist