dsh-knit 0.13.0 → 0.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/README.en.md +47 -3
- package/README.md +40 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,44 @@
|
|
|
3
3
|
本项目的重要变更都记在这里。格式参考 [Keep a Changelog](https://keepachangelog.com/),
|
|
4
4
|
版本号遵循[语义化版本](https://semver.org/lang/zh-CN/)。
|
|
5
5
|
|
|
6
|
+
## [0.13.1] - 2026-09-23
|
|
7
|
+
|
|
8
|
+
**只改文档,插件行为一行没动。** 没有新功能、没有修 bug ——
|
|
9
|
+
**装过 `0.13.0` 的人没有任何必须升级的理由。**
|
|
10
|
+
|
|
11
|
+
那为什么还要发一版?因为 **npm 页面上渲染的 README 是「已发布 tarball 里的那一份」**。
|
|
12
|
+
`0.13.0` 之后我们往 README 里补了重排动图和两张真机截图,但那个包的 README 是**冻结**的 ——
|
|
13
|
+
不重新发一版,npm 那个页面就永远停在老版本:没有动图、没有反馈入口。
|
|
14
|
+
|
|
15
|
+
### 包内实际变化
|
|
16
|
+
|
|
17
|
+
只有两个文件(其余改动不在 `package.json` 的 `files` 白名单里,压根不进包):
|
|
18
|
+
|
|
19
|
+
| 文件 | 变化 |
|
|
20
|
+
|---|---|
|
|
21
|
+
| `README.md` / `README.en.md` | 第 1 屏接上**重排动图**;新增「反馈」与「升级」两节;补「图片与视频」「全部」两档真机截图;图注篇数 `34 → 36`;更正关于下载量的说法;修掉过期的测试数 |
|
|
22
|
+
| `CHANGELOG.md` | 本节 |
|
|
23
|
+
|
|
24
|
+
### 不进包的改动(在仓库里,但 `files` 没收录)
|
|
25
|
+
|
|
26
|
+
| 文件 | 说明 |
|
|
27
|
+
|---|---|
|
|
28
|
+
| `docs/demo-reorder.gif`(新增 1.3 MB) | README 用**绝对 raw URL** 引用,所以 npm 页面上照样显示 |
|
|
29
|
+
| `docs/screenshot-media.png` / `screenshot-all.png`(新增) | 同上 |
|
|
30
|
+
| `screenshots.json` | **1 张 → 3 张**(市场详情页的相册会自动跟着变,不用提 PR) |
|
|
31
|
+
| `tools/make-demo-gif.mjs`(新增) | 录屏 → GIF 的编码器,含 `--crop` |
|
|
32
|
+
| `tools/market-recheck.mjs`(新增) | 市场索引 + 下载量复查,含「形状判读」 |
|
|
33
|
+
|
|
34
|
+
### 顺带纠正一句我们自己说错的话
|
|
35
|
+
|
|
36
|
+
npm 的下载量**不是人**。决定性证据:`0.5.0` 只当了 **28 分 09 秒** `latest` 就被下载 **155** 次,
|
|
37
|
+
而 `0.13.0` 当了 **59.6 小时** 才 **161** 次 —— **曝光时长差 127 倍,下载量只差 1.04 倍**
|
|
38
|
+
(皮尔逊 r = 0.317;真实安装应当接近 +1)。`npm install` 只解析 `latest`,
|
|
39
|
+
**没有哪个真人渠道能造出这个形状**。版本分布也是平线:8 个版本几乎均分,
|
|
40
|
+
`latest` 占比只有 **14.4%**(对照真包 60–80%)。
|
|
41
|
+
|
|
42
|
+
⇒ README 里现在按这个口径写:**那个数字不能读成「这么多人在用」。**
|
|
43
|
+
|
|
6
44
|
## [0.13.0] - 2026-09-20
|
|
7
45
|
|
|
8
46
|
**三件事,都是真机体验打回来之后改的:**
|
package/README.en.md
CHANGED
|
@@ -7,13 +7,21 @@
|
|
|
7
7
|
|
|
8
8
|

|
|
9
9
|
|
|
10
|
-
*Screenshot from a real machine, not a mock-up: a workspace with
|
|
10
|
+
*Screenshot from a real machine, not a mock-up: a workspace with 36 documents — the list, an inline
|
|
11
11
|
preview, and the references bar.*
|
|
12
12
|
*The references bar is new in v0.12: expand it to see which documents reference this one, and click
|
|
13
13
|
one to jump straight there.*
|
|
14
14
|
*The top line follows whatever you're talking about; when there isn't enough conversation yet it
|
|
15
15
|
falls back to newest-first and states its basis.*
|
|
16
16
|
|
|
17
|
+

|
|
18
|
+
|
|
19
|
+
*Order follows the conversation — same workspace, same session: ask "how is BM25 weighted for the
|
|
20
|
+
ranking?" and the sorting docs move to the top; then ask "how do I check plugin-market listings and
|
|
21
|
+
download counts?" and the market-research docs take over.*
|
|
22
|
+
*⚠️ The panel polls **every 5 seconds**, so the re-rank lands **0–5 s** after the message rather than
|
|
23
|
+
instantly, and the GIF runs faster than real time.*
|
|
24
|
+
|
|
17
25
|
Scans Markdown / images / video across the project folder · Order follows the conversation · No model calls, no network
|
|
18
26
|
|
|
19
27
|
```sh
|
|
@@ -172,6 +180,27 @@ Then **restart DSH** and hard-refresh the browser (`Cmd + Shift + R`).
|
|
|
172
180
|
**Optional**: if `dsh-better-sidebar` is installed, the panel also registers
|
|
173
181
|
as one of its tabs. Each host is an independent optional dependency; missing one doesn't affect the other.
|
|
174
182
|
|
|
183
|
+
**Upgrading**: same command as installing, and the same restart + hard-refresh afterwards.
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Feedback
|
|
188
|
+
|
|
189
|
+
**Right now this project is not about adding features — it's about finding out whether
|
|
190
|
+
"rank project docs by the current conversation" is something anyone actually uses.**
|
|
191
|
+
So the most valuable thing you can send is not "could you add X" but **how you work around
|
|
192
|
+
this today** — including "I installed it and never opened it", which is more useful than a
|
|
193
|
+
feature request.
|
|
194
|
+
|
|
195
|
+
- 💬 [Tell us when you actually open it](https://github.com/PolinniZhong/dsh-knit/issues/new?template=feature.yml) — two fields, thirty seconds
|
|
196
|
+
- 🐞 [Won't install / panel won't open / ranking looks wrong](https://github.com/PolinniZhong/dsh-knit/issues/new?template=bug.yml)
|
|
197
|
+
- 📖 Check [known limitations](#known-limitations) first — short conversations degrade to time order and Chinese uses n-gram approximation; those are deliberate trade-offs, not bugs
|
|
198
|
+
|
|
199
|
+
> A single issue is treated as a real signal. So far this plugin has **no trace of a single
|
|
200
|
+
> real user** — the npm download count is automated version enumeration, not people
|
|
201
|
+
> (only 14% of it is `latest`, and a human install only ever pulls `latest`). One human reply
|
|
202
|
+
> changes what gets built next.
|
|
203
|
+
|
|
175
204
|
---
|
|
176
205
|
|
|
177
206
|
## Features
|
|
@@ -204,6 +233,21 @@ as one of its tabs. Each host is an independent optional dependency; missing one
|
|
|
204
233
|
> Relevance is deliberately **not visualised** (no percentages, no bars) — the ranking itself is
|
|
205
234
|
> the answer; position is relevance.
|
|
206
235
|
|
|
236
|
+
### The other two views
|
|
237
|
+
|
|
238
|
+

|
|
239
|
+
|
|
240
|
+
*Images & video: square thumbnails, with the **column count following the panel width continuously** —
|
|
241
|
+
six columns at this width, cells about 112px. Videos show their first frame as a poster with a play
|
|
242
|
+
glyph and a duration badge. These are the workspace's real image and SVG files; this particular
|
|
243
|
+
workspace happens to hold several screenshots and two icon files.*
|
|
244
|
+
|
|
245
|
+

|
|
246
|
+
|
|
247
|
+
*All: documents on top (max 4, with a "View all →" link when truncated) and images & video below
|
|
248
|
+
(**never truncated**, count only). Documents lay out in **two columns** here, and all four fields —
|
|
249
|
+
title, time, summary, path — are still present: column count changes the layout, never the data.*
|
|
250
|
+
|
|
207
251
|
---
|
|
208
252
|
|
|
209
253
|
## What it reads, and what it doesn't
|
|
@@ -254,7 +298,7 @@ The relevance figure only affects ordering — it is **never displayed and never
|
|
|
254
298
|
git clone https://github.com/PolinniZhong/dsh-knit.git
|
|
255
299
|
cd dsh-knit
|
|
256
300
|
|
|
257
|
-
npm test #
|
|
301
|
+
npm test # 285 tests, zero dependencies, no npm install needed
|
|
258
302
|
```
|
|
259
303
|
|
|
260
304
|
**How changes take effect**: the host half (`src/host/`) **requires a DSH restart** (no hot reload);
|
|
@@ -274,7 +318,7 @@ knit/
|
|
|
274
318
|
│ ├── host/index.js # /knit/api/recent · /doc · /raw
|
|
275
319
|
│ ├── host/relevance.js # the relevance engine: BM25 + keyword extraction
|
|
276
320
|
│ └── client/client.js # dual-host registration + panel UI
|
|
277
|
-
└── test/ #
|
|
321
|
+
└── test/ # 285 tests
|
|
278
322
|
```
|
|
279
323
|
|
|
280
324
|
Details and trade-offs live in the source comments; see [CONTRIBUTING.md](CONTRIBUTING.md)
|
package/README.md
CHANGED
|
@@ -7,10 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|

|
|
9
9
|
|
|
10
|
-
*真机截图(不是原型):一个含
|
|
10
|
+
*真机截图(不是原型):一个含 36 篇文档的工作区 —— 列表 + 就地预览 + 引用条。*
|
|
11
11
|
*引用条是 v0.12 加的:展开就能看到「这篇被谁引用」,点一项直接跳过去。*
|
|
12
12
|
*顶行会跟着你正在聊什么变;对话内容还不足时它退回按时间排,并如实说明依据。*
|
|
13
13
|
|
|
14
|
+

|
|
15
|
+
|
|
16
|
+
*排序跟着对话走(同一个工作区、同一个会话):先问「排序算法用的 BM25 是怎么加权的?」,*
|
|
17
|
+
*顶上换成排序那几篇;再问「插件市场收录和下载量怎么查?」,顶上又换成市场调研那几篇。*
|
|
18
|
+
*⚠️ 面板是**每 5 秒轮询一次**的,所以重排落在发消息之后的 **0–5 秒**内、不是瞬时;动图比真实时间快。*
|
|
19
|
+
|
|
14
20
|
扫整个项目文件夹的 Markdown / 图片 / 视频 · 排序跟着对话走 · 不调模型、不联网
|
|
15
21
|
|
|
16
22
|
```sh
|
|
@@ -125,6 +131,24 @@ dsh plugin --profile web add dsh-knit
|
|
|
125
131
|
**可选**:装了 `dsh-better-sidebar` 的话,面板也会注册成它的一个 tab;
|
|
126
132
|
没装不受影响,两边是各自独立的可选依赖。
|
|
127
133
|
|
|
134
|
+
**升级**:命令和首次安装是同一条,装完同样要**重启 DSH** + 硬刷新。
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 反馈
|
|
139
|
+
|
|
140
|
+
**这个项目当前的重心不是加功能,是搞清楚「按对话给文档排序」这件事到底有没有人在用。**
|
|
141
|
+
所以最有价值的一句话不是「能不能加个 XX」,而是**你现在是怎么绕过它的** ——
|
|
142
|
+
哪怕结论是「装了,但一周没打开过」,也请直说,那比一个功能建议有用得多。
|
|
143
|
+
|
|
144
|
+
- 💬 [说说你在什么场景下会打开它](https://github.com/PolinniZhong/dsh-knit/issues/new?template=feature.yml) —— 两步、三十秒,不必客气
|
|
145
|
+
- 🐞 [装不上 / 面板打不开 / 排得不对](https://github.com/PolinniZhong/dsh-knit/issues/new?template=bug.yml)
|
|
146
|
+
- 📖 提之前先看一眼[已知限制](#已知限制) —— 短对话退化、中文用 n-gram 近似,这几条是已知的取舍,不是 bug
|
|
147
|
+
|
|
148
|
+
> 一条 issue 会被当成真实信号处理。这个插件到现在**一个真实用户的痕迹都没有**
|
|
149
|
+
> (npm 那个下载量是自动化版本枚举、不是人 —— `latest` 占比只有 14%,而真人只会装 `latest`)
|
|
150
|
+
> —— 一条有人味儿的反馈能直接改变接下来做什么。
|
|
151
|
+
|
|
128
152
|
---
|
|
129
153
|
|
|
130
154
|
## 功能
|
|
@@ -157,6 +181,19 @@ dsh plugin --profile web add dsh-knit
|
|
|
157
181
|
|
|
158
182
|
> 相关度**不做可视化**(不显示百分比、不画长条)—— 排序本身就是答案,名次即相关度。
|
|
159
183
|
|
|
184
|
+
### 另外两档长什么样
|
|
185
|
+
|
|
186
|
+

|
|
187
|
+
|
|
188
|
+
*图片与视频:方形缩略图,**列数跟着面板宽度连续变** —— 这一屏是 6 列,格子约 112px。*
|
|
189
|
+
*视频取首帧当海报,中央叠播放三角、右下角叠时长。列出的就是工作区里真实的图片与 SVG 文件 ——*
|
|
190
|
+
*这个工作区里正好有几张截图和两个图标,所以看起来像一屏文件缩略图。*
|
|
191
|
+
|
|
192
|
+

|
|
193
|
+
|
|
194
|
+
*全部:上区文档(最多 4 条,超出时右侧给「查看全部 →」)、下区图片与视频(**不截断**,只给计数)。*
|
|
195
|
+
*文档在这一档排成 **2 列**,标题 / 时间 / 摘要 / 路径**四个字段一个不少** —— 列数只改排版,不砍数据。*
|
|
196
|
+
|
|
160
197
|
---
|
|
161
198
|
|
|
162
199
|
## 也给 agent 用:`knit_docs` 工具
|
|
@@ -231,7 +268,7 @@ Knit 一装上就有整个项目的历史文档可用。
|
|
|
231
268
|
git clone https://github.com/PolinniZhong/dsh-knit.git
|
|
232
269
|
cd dsh-knit
|
|
233
270
|
|
|
234
|
-
npm test #
|
|
271
|
+
npm test # 285 项,零依赖,不需要先 npm install
|
|
235
272
|
```
|
|
236
273
|
|
|
237
274
|
**改动生效方式**:宿主半边(`src/host/`)改了**必须重启 DSH**(实测不热加载);
|
|
@@ -252,7 +289,7 @@ knit/
|
|
|
252
289
|
│ ├── host/relevance.js # 相关性引擎:BM25 + 关键词抽取(纯函数)
|
|
253
290
|
│ ├── host/tool.js # agent 文档工具 knit_docs(手写 ToolDefinition)
|
|
254
291
|
│ └── client/client.js # 双宿主注册 + 面板 UI
|
|
255
|
-
└── test/ #
|
|
292
|
+
└── test/ # 285 项测试
|
|
256
293
|
└── eval/ # 离线质量评测:语料 + 用例 + 冻结的 v0.5.2 基线
|
|
257
294
|
```
|
|
258
295
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-knit",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Find the doc your agent just wrote. Lists the DSH workspace's Markdown, images and video in the sidebar, ranked by relevance to the current conversation, with inline preview — and hands the same ranking to the agent as a tool, returning the passage that matched in each document. Zero model calls, zero network.",
|
|
6
6
|
"main": "./src/host/index.js",
|