Fix #1540: fix:#1824
Merged
Merged
Conversation
5e7befb to
d90c41a
Compare
…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.
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
已修复 issue #1540:在 apps/memos-local-plugin/README.md 的 Quick start 顶部增加
!IMPORTANT警示,明确说明不要执行npm install -g、解释原因(不会部署到 agent home、不会写 config.yaml、不会启动 bridge/viewer,且 tarball 只发布 dist/ + viewer/dist/ 不含源码),并新增 Troubleshooting 子节回应用户报告的两个具体症状("包不存在" 误解,以及web//site/目录命名陈旧 —— 前者已重命名为viewer/,后者已在 b683f8a 移除)。CHANGELOG 同步登记。仅文档变更,不影响代码与运行时。已 commit 到 autodev/MemOS-1540 并 push 到远端,待 scheduler 兜底创建 PR。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
@CarltonXiang, @syzsunshine219 please review this PR.
Reviewer Checklist