@khorsheed/dsh-library 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 变更记录
+
+## 0.1.0（2026-10-26）
+
+首个公开发布：图书馆——让 agent 当你的读书教练，帮你排进度、记笔记、出题，还盯着你把错题订正对。随「学习套件」安装，只在学习模式的会话里出现。
+
+- **说清读什么就能开始**：书名和版本说清楚就够，不用上传整本书；只说想学的领域也行，教练照你的底子挑知识点和教材。
+- **路线你点头才算**：教练照目录起草学习路线，你点「采用」才生效。路线是一条竖排的课程轨道，每一站是一课（3–5 个考点），标着状态和考点进度；没有哪一站上锁，可以跟着走，也可以挑感兴趣的先学。
+- **每站一份讲义**：从站点导引的「开始学这一站」打开讲义页，讲义就是这一课本身（参考资料放在最后），覆盖这一站的每个考点；进站时才写，旧版本保留。
+- **拍一页就能记笔记**：读到哪页拍一下，划线和页边批注自动整理成卡片。
+- **学完一站就测**：每一站都是一套带考点的小测，题目从你划过、问过、做错的内容里出；选择填空当场出分，问答题教练来批；过关后教练问你下一站学什么。
+- **错题不翻篇**：答错的题进「待订正」，订正对了才算掌握这个考点；「今日」把待订正的题和该复习的卡片列好。
+- **书和项目页一目了然**：封面、干净的书名、分段进度条，目录默认折叠；删除前用宿主的确认框按类列出会删掉什么。
+- **教练的工具面精简**：工具描述和提示词大幅瘦身（工具约 23.9k → 10.7k 字符，提示约 2.8k → 1.2k），结果更短并附下一步；讲义放错位置时直接告诉它怎么改。

package/README.en.md

@@ -0,0 +1,49 @@
+# @khorsheed/dsh-library
+
+English | [中文](README.md)
+
+Let an agent be your reading coach: it plans your pace, takes your notes, writes your quizzes, and keeps after you until every wrong answer is fixed.
+
+The hard part of teaching yourself a book is that nobody keeps you on track: you plan the pace, copy the notes, write the questions, and the ones you got wrong are forgotten by next time. With the library, tell the coach which book you're reading and it drafts a study path first; snap a page as you read and your highlights and margin notes become cards; take a short quiz after each chapter, and the questions you missed stay around until you get them right.
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-1.png" width="560" alt="A learning-mode session: the coach's grading table on the left; on the right, the Library's Today page with your projects, today's retakes and recent changes">
+
+## What it does
+
+- **Say what you're reading and start**: the title and edition are enough; no need to upload the book. Or just name a field ("calculus from zero, pick the textbook for me") and it picks the topics and textbooks for your level.
+- **It drafts the path, you say yes**: it plans a study path from the table of contents; nothing counts until you press "Adopt as this textbook’s path". Then follow it station by station, or jump to whichever station interests you first.
+- **Snap a page, get your notes**: photograph the page you're on and your highlights and margin notes turn into cards; no copying by hand.
+- **Finish a chapter, take a quiz**: questions come from what you highlighted, asked about, and got wrong; multiple choice and fill-in are marked on the spot, the coach marks the open questions.
+- **Wrong answers don't get dropped**: missed questions go to "To retake", and a topic only counts as learned once you get them right.
+- **A review list every day**: the Today page lists the questions to retake and the cards due, so you know what to do the moment you open it.
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-2.png" width="560" alt="A textbook's path page: a 14-station study path with stations passed and points mastered at the top, and Retake 7 and Continue on the current station">
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-3.png" width="560" alt="A retake paper: the missed questions one by one, each with an answer box and Submit, Approach and Broken buttons">
+
+## Install
+
+In DSH, open Plugins → Add plugin, enter this package name, and press Install:
+
+```
+@khorsheed/dsh-learning-suite
+```
+
+The library comes with the Learning Suite. Then start a new session, pick "学习模式" (learning mode), and tell the coach what you want to read.
+
+The library only appears in "学习模式" (learning mode) sessions. Its tools only make sense in learning mode, so they are handed only to learning mode sessions and other modes don't get tools and buttons they can't use. That is also why it should be installed with its suite rather than on its own — installed alone it doesn't show up.
+
+## Known limitations
+
+- It doesn't read ebook files (EPUB, PDF); it records the title and table of contents only.
+- Photos you take are sent into the session as a message, and the coach reads them there.
+
+## Compatibility
+
+Needs DSH 0.1.7 or later; verified on 0.2.1.
+
+## For developers
+
+- Entry points: `src/index.ts` (service and sidebar) and `src/tool.ts` (the coach's model tools); each tool's usage is in its own description.
+- You can install this package alone (`dsh plugin --profile web add @khorsheed/dsh-library`), but its model tools must be granted by a mode, so on its own the sidebar does not appear.
+- Part of [dsh-plugins](https://github.com/Khorsheed/dsh-plugins); open issues and contributions there. Changes: [CHANGELOG.md](CHANGELOG.md).

package/README.i18n.yaml

@@ -0,0 +1,6 @@
+# Bilingual-pair consistency record: the git blob hash of each side as of the
+# last confirmed-consistent state. Both languages carry equal authority; after
+# editing either side, bring the other along and re-record with:
+#   pnpm run verify-translation-pairing --write packages/library/README.en.md
+packages/library/README.en.md: 2c0c4917eb346335dc489156c65c8abd17555f2e
+packages/library/README.md: c1a2eac3d86c90c2c01f4479fa5c7c68f695ddb0

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @khorsheed/dsh-library
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[English](README.en.md) | 中文
+
+让 agent 当你的读书教练：帮你排进度、记笔记、出题，还盯着你把错题订正对。
+
+自学一本书，最烦的是没人管：进度自己排，笔记自己抄，题自己出，错题下次还没人提醒。装上图书馆，告诉教练你在读哪本书，它会先帮你排一版学习路线；读的时候拍一页书，划线和页边批注会自动整理成卡片；每学完一章做套小测，错题会一直留着，直到你订正对为止。
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-1.png" width="560" alt="学习模式的会话：左边是教练给出的判分结果表，右栏图书馆的今日页列出各个学习项目、今日复习里待订正的题和最近的变化">
+
+## 能做什么
+
+- **告诉它读什么就能开始**：书名和版本说清楚就够，不用上传整本书；只说想学的领域也行（「从零学微积分，教材你帮我挑」），它照你的底子挑知识点和教材。
+- **路线它先排，你点头才算**：它会照目录起草一版学习路线，你看着合适点「采用」才生效；之后可以跟着路线一站站过关，也可以挑感兴趣的站先学。
+- **拍一页就能记笔记**：读到哪页拍一下，划线和页边批注自动变成卡片，不用手抄。
+- **学完一章就测**：题目从你划过的、问过的、做错的内容里出；选择填空当场出分，问答题教练来批。
+- **错题不翻篇**：答错的题进「待订正」，订正对了才算掌握这个知识点。
+- **每天照着清单复习**：今日页把要订正的题、该复习的卡片列好，打开就知道干什么。
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-2.png" width="560" alt="一本教材的路线页：14 站的学习路线，顶部是站过关和考点掌握进度，当前一站有「去订正 7 题」和「接着学这一站」">
+
+<img src="https://raw.githubusercontent.com/Khorsheed/dsh-basic/main/docs/screenshots/learning-3.png" width="560" alt="订正页：错题逐题列出，每题下面是作答框和「提交」「讲讲思路」「题有问题」">
+
+## 安装
+
+在 DSH 的「插件 → 添加插件」里输入下面的包名，点安装：
+
+```
+@khorsheed/dsh-learning-suite
+```
+
+图书馆会跟着「学习套件」一起装好。装完开一个新会话，选「学习模式」，告诉教练你想读什么书。
+
+图书馆只在学习模式的会话里出现。它的工具只对学习模式有用，所以只交给学习模式的会话，其它模式不会多出用不上的工具和按钮；这也是要连同套件一起装、不要只装本包的原因——单独装时它不会出现。
+
+## 已知限制
+
+- 不读取书的电子文件（EPUB、PDF），只登记书名和目录。
+- 拍的照片会作为一条消息发进会话，由教练来识别。
+
+## Compatibility
+
+需要 DSH 0.1.7 或更新版本，已在 0.2.1 上验证。
+
+## 给开发者
+
+- 入口：`src/index.ts`（服务与侧栏）、`src/tool.ts`（教练用的模型工具）；工具的用法写在各自的描述里。
+- 也可以单独安装本包（`dsh plugin --profile web add @khorsheed/dsh-library`），但它的模型工具要由某个模式授予，单装时侧栏不会出现。
+- 隶属 [dsh-plugins](https://github.com/Khorsheed/dsh-plugins)，问题与贡献请到该仓库；变更见 [CHANGELOG.md](CHANGELOG.md)。

package/cordis.patch.yml

@@ -0,0 +1,17 @@
+# @khorsheed/dsh-library bundle patch: inserts the library row into the
+# composing profile, so `dsh plugin --profile <name> add @khorsheed/dsh-library`
+# reconciles it into the bundles layer. The row is a bare mount — the host half
+# provides the `library` service core and mounts its thin Remote face; the
+# browser half is discovered through the package.json `dsh.client` block. The
+# model face (library_read + library_<名词> 写工具 + library_assess + the coach prompt
+# section + the library skill) is NOT this row: it is the `./tool` composition
+# entry, which an agent preset names (the evaluation-family fold pattern) — a
+# profile-root tool row would grant every session.
+#
+# NOTE: a composition must mount this row id exactly once. Official images
+# mount no library row, so plugin-adding this package is the install path
+# there; a composition that already mounts the id by other means must NOT also
+# add it — a duplicate loader entry id fails boot.
+- insert:
+    - id: library
+      name: "@khorsheed/dsh-library"