@itradingai/aiwiki 0.2.22 → 0.2.24
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/README.md +43 -76
- package/README.zh-CN.md +41 -52
- package/docs/README.md +3 -0
- package/docs/SHOWCASE.md +24 -0
- package/docs/USAGE.md +24 -0
- package/docs/USAGE.zh-CN.md +4 -0
- package/docs/development-log.md +86 -0
- package/examples/public-trial-scenarios/README.md +173 -0
- package/examples/public-trial-scenarios/input/article-research.md +26 -0
- package/examples/public-trial-scenarios/input/project-decision.md +35 -0
- package/examples/public-trial-scenarios/input/topic-planning.md +28 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ Use it to build a local AI knowledge base that can be queried, checked, maintain
|
|
|
28
28
|
|
|
29
29
|
Ask your AI assistant to install and configure AIWiki.
|
|
30
30
|
|
|
31
|
-
Choose a local folder for your knowledge base.
|
|
31
|
+
1. Choose a local folder for your knowledge base.
|
|
32
32
|
|
|
33
33
|
```text
|
|
34
34
|
Windows: D:\AIWiki
|
|
@@ -36,7 +36,9 @@ macOS/Linux: ~/AIWiki
|
|
|
36
36
|
Project test: ./aiwiki-test
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Copy this prompt into Codex, Claude Code, QClaw, OpenClaw, or another local coding assistant
|
|
39
|
+
2. Copy this prompt into Codex, Claude Code, QClaw, OpenClaw, or another local coding assistant.
|
|
40
|
+
|
|
41
|
+
Before sending it, replace every `<replace-with-my-aiwiki-path>` with your own local folder path, such as `D:\AIWiki` or `~/AIWiki`. Do not leave the placeholder in the commands.
|
|
40
42
|
|
|
41
43
|
```text
|
|
42
44
|
Please install and configure AIWiki for me.
|
|
@@ -48,6 +50,8 @@ Use this knowledge base path:
|
|
|
48
50
|
|
|
49
51
|
<replace-with-my-aiwiki-path>
|
|
50
52
|
|
|
53
|
+
Replace every `<replace-with-my-aiwiki-path>` below with my own local folder path before running commands. If I left the placeholder unchanged, stop and ask me for the real path.
|
|
54
|
+
|
|
51
55
|
Run these commands:
|
|
52
56
|
|
|
53
57
|
npm install -g @itradingai/aiwiki@latest
|
|
@@ -68,37 +72,13 @@ Then tell me:
|
|
|
68
72
|
5. what I should do next
|
|
69
73
|
```
|
|
70
74
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
- `aiwiki agent sync --yes` syncs AIWiki instructions into supported local assistant environments.
|
|
74
|
-
- `aiwiki agent sync --path "<workspace>" --yes` writes workspace-level guidance so assistants entering the knowledge base know to use AIWiki commands first.
|
|
75
|
-
|
|
76
|
-
After syncing, restart or reload your assistant if needed.
|
|
77
|
-
|
|
78
|
-
### Expected result
|
|
75
|
+
3. Restart or reload your assistant if needed.
|
|
79
76
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
- `aiwiki` is installed and reports a version
|
|
83
|
-
- the knowledge base path exists and passes `aiwiki doctor`
|
|
84
|
-
- assistant integration is `installed`, `updated`, or `current`
|
|
85
|
-
- workspace guidance was written by `aiwiki agent sync --path`
|
|
86
|
-
- `aiwiki status` reports the workspace state and next action
|
|
77
|
+
If assistant sync fails, open an [Agent Integration issue](https://github.com/iTradingAI/aiwiki/issues/new?template=agent_integration.md) and include the output of `aiwiki agent check --json` and `aiwiki doctor --path "<workspace>"`.
|
|
87
78
|
|
|
88
79
|
## First Use
|
|
89
80
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
Use this path when you are trying AIWiki for the first time:
|
|
93
|
-
|
|
94
|
-
1. Run the Quick Start prompt above with a temporary knowledge base path.
|
|
95
|
-
2. Send one article, file, or note to your assistant and ask it to ingest the source into AIWiki.
|
|
96
|
-
3. Ask one question about the ingested topic so the assistant calls `aiwiki context`.
|
|
97
|
-
4. Run `aiwiki query "<topic>"` when you want a direct terminal view.
|
|
98
|
-
5. Ask the assistant to check the workspace with `aiwiki lint --json` and `aiwiki doctor`.
|
|
99
|
-
6. Share feedback with the short template in [`docs/TRIAL_FEEDBACK_TEMPLATE.md`](docs/TRIAL_FEEDBACK_TEMPLATE.md).
|
|
100
|
-
|
|
101
|
-
The point of the first trial is not to build a large archive. It is to confirm that one source can move from reading, to traceable Markdown files, to later reuse.
|
|
81
|
+
Trying AIWiki for the first time? Use the short trial route in the [Usage Guide](docs/USAGE.md#3-ingest-a-source).
|
|
102
82
|
|
|
103
83
|
### Ingest a source
|
|
104
84
|
|
|
@@ -152,13 +132,6 @@ The assistant should call:
|
|
|
152
132
|
aiwiki lint --json
|
|
153
133
|
```
|
|
154
134
|
|
|
155
|
-
When only safe fixes are reported and you allow cleanup, the assistant may run:
|
|
156
|
-
|
|
157
|
-
```bash
|
|
158
|
-
aiwiki lint --fix-empty-dirs --json
|
|
159
|
-
aiwiki lint --json
|
|
160
|
-
```
|
|
161
|
-
|
|
162
135
|
## What AIWiki Creates
|
|
163
136
|
|
|
164
137
|
A successful ingest creates a traceable knowledge package:
|
|
@@ -181,19 +154,11 @@ Optional files may also be created when the assistant provides enough structured
|
|
|
181
154
|
|
|
182
155
|
The Wiki Entry is the main reusable knowledge surface. The raw record and source card preserve traceability, so you can always go back from a summary to the source.
|
|
183
156
|
|
|
184
|
-
A successful first run should leave you with:
|
|
185
|
-
|
|
186
|
-
- a new folder under `09-runs/`
|
|
187
|
-
- `payload.json` and `processing-summary.md` inside that run folder
|
|
188
|
-
- a Source Card under `03-sources/article-cards/`
|
|
189
|
-
- a reusable Wiki Entry under `05-wiki/source-knowledge/`
|
|
190
|
-
- `aiwiki query "<topic>"` or `aiwiki context "<topic>"` returning a relevant match
|
|
191
|
-
- `aiwiki lint --json` returning structure feedback instead of requiring manual file inspection first
|
|
192
|
-
|
|
193
157
|
See:
|
|
194
158
|
|
|
195
159
|
- [`examples/demo-run/`](examples/demo-run/)
|
|
196
160
|
- [`examples/obsidian-vault-sample/`](examples/obsidian-vault-sample/)
|
|
161
|
+
- [`examples/public-trial-scenarios/`](examples/public-trial-scenarios/)
|
|
197
162
|
|
|
198
163
|
## Why AIWiki
|
|
199
164
|
|
|
@@ -209,9 +174,12 @@ Instead of saving links and losing context, you get Markdown files that your ass
|
|
|
209
174
|
|
|
210
175
|
## Practical Scenarios
|
|
211
176
|
|
|
212
|
-
- **
|
|
213
|
-
- **
|
|
214
|
-
- **
|
|
177
|
+
- **Build a personal research wiki** from articles, PDFs, files, and notes.
|
|
178
|
+
- **Turn useful reading into reusable ideas** such as concepts, claims, topics, and outlines.
|
|
179
|
+
- **Give Codex, Claude Code, or QClaw a stable local knowledge layer** it can query before answering.
|
|
180
|
+
- **Keep summaries traceable** with raw records, source cards, Wiki Entries, and run records.
|
|
181
|
+
|
|
182
|
+
For a guided first trial, use the [public-trial scenario pack](examples/public-trial-scenarios/). It includes article research, topic planning, and project decision memory samples, with commands, expected artifacts, query/context reuse examples, and WeChat-group-ready usage copy.
|
|
215
183
|
|
|
216
184
|
## How It Works
|
|
217
185
|
|
|
@@ -256,43 +224,40 @@ The goal is simple: make what your assistant reads useful again later.
|
|
|
256
224
|
|
|
257
225
|
## Agent Integration
|
|
258
226
|
|
|
259
|
-
AIWiki is built for assistant-driven workflows.
|
|
260
|
-
|
|
261
|
-
Supported local assistant targets may include:
|
|
227
|
+
AIWiki is built for assistant-driven workflows. `aiwiki agent sync --yes` syncs packaged AIWiki instructions into supported local assistant environments, and `aiwiki agent sync --path "<workspace>" --yes` writes workspace guidance so assistants entering the knowledge base use AIWiki commands first.
|
|
262
228
|
|
|
263
|
-
-
|
|
264
|
-
- Claude Code
|
|
265
|
-
- QClaw
|
|
266
|
-
- OpenClaw
|
|
229
|
+
See [Agent Handoff](docs/AGENT_HANDOFF.md) for the full command-first contract.
|
|
267
230
|
|
|
268
|
-
|
|
231
|
+
## Obsidian and Dataview
|
|
269
232
|
|
|
270
|
-
|
|
271
|
-
aiwiki agent sync --yes
|
|
272
|
-
aiwiki agent sync --path "<workspace>" --yes
|
|
273
|
-
aiwiki agent check --json
|
|
274
|
-
aiwiki agent check --path "<workspace>" --json
|
|
275
|
-
```
|
|
233
|
+
AIWiki writes plain Markdown and frontmatter.
|
|
276
234
|
|
|
277
|
-
|
|
235
|
+
Obsidian is optional but useful as a viewing surface. Dataview is an optional dashboard enhancement.
|
|
278
236
|
|
|
279
|
-
|
|
280
|
-
aiwiki prompt agent
|
|
281
|
-
```
|
|
237
|
+
AIWiki does not require Obsidian, does not auto-install Dataview, and does not edit `.obsidian`.
|
|
282
238
|
|
|
283
|
-
|
|
239
|
+
Review Queue is not the main workflow. AIWiki creates Wiki entries first, then uses lint and assistant workflows to keep the workspace clean.
|
|
284
240
|
|
|
285
|
-
|
|
241
|
+
## Security and Privacy
|
|
286
242
|
|
|
287
|
-
|
|
243
|
+
- AIWiki writes local Markdown and JSON files.
|
|
244
|
+
- AIWiki does not upload your knowledge base.
|
|
245
|
+
- AIWiki does not include a built-in LLM.
|
|
246
|
+
- AIWiki does not crawl the web by itself.
|
|
247
|
+
- `npm install` does not modify assistant configuration.
|
|
248
|
+
- Agent integration is explicit through `aiwiki agent sync`.
|
|
288
249
|
|
|
289
|
-
|
|
250
|
+
## Current Status
|
|
290
251
|
|
|
291
|
-
|
|
252
|
+
AIWiki currently focuses on:
|
|
292
253
|
|
|
293
|
-
|
|
254
|
+
- one local AIWiki knowledge base
|
|
255
|
+
- local Markdown and frontmatter retrieval
|
|
256
|
+
- assistant-driven ingest
|
|
257
|
+
- Source Cards and Wiki Entries
|
|
258
|
+
- `context`, `query`, `lint`, `status`, and `doctor` workflows
|
|
294
259
|
|
|
295
|
-
|
|
260
|
+
Semantic search, vector indexing, browser clipping, RSS collection, and enterprise permissions are intentionally out of scope for now.
|
|
296
261
|
|
|
297
262
|
## Boundaries
|
|
298
263
|
|
|
@@ -317,9 +282,10 @@ AIWiki is developed by iTradingAI.
|
|
|
317
282
|
|
|
318
283
|
For Chinese users, scan the QR codes below to join the WeChat group or follow the official account.
|
|
319
284
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
285
|
+
<p>
|
|
286
|
+
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/join-group.png" alt="Join WeChat group" width="220" />
|
|
287
|
+
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/wechat-official-account.png" alt="WeChat official account" width="220" />
|
|
288
|
+
</p>
|
|
323
289
|
|
|
324
290
|
## Documentation
|
|
325
291
|
|
|
@@ -328,6 +294,7 @@ For Chinese users, scan the QR codes below to join the WeChat group or follow th
|
|
|
328
294
|
- [Agent Handoff](docs/AGENT_HANDOFF.md)
|
|
329
295
|
- [FAQ](docs/FAQ.md)
|
|
330
296
|
- [Showcase](docs/SHOWCASE.md)
|
|
297
|
+
- [Public Trial Scenarios](examples/public-trial-scenarios/)
|
|
331
298
|
- [Trial Feedback Template](docs/TRIAL_FEEDBACK_TEMPLATE.md)
|
|
332
299
|
- [Roadmap](docs/ROADMAP.md)
|
|
333
300
|
- [Release Notes](docs/RELEASE.md)
|
package/README.zh-CN.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/aiwiki-hero.png" alt="AIWiki" width="100%" />
|
|
2
|
+
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/aiwiki-hero.zh-CN.png" alt="AIWiki" width="100%" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
@@ -24,7 +24,7 @@ AIWiki 是给 AI 助手使用的本地 Markdown 知识库。
|
|
|
24
24
|
|
|
25
25
|
## 快速开始
|
|
26
26
|
|
|
27
|
-
先选一个本地文件夹作为 AIWiki 知识库。示例:
|
|
27
|
+
1. 先选一个本地文件夹作为 AIWiki 知识库。示例:
|
|
28
28
|
|
|
29
29
|
```text
|
|
30
30
|
Windows: D:\AIWiki
|
|
@@ -32,7 +32,9 @@ macOS/Linux: ~/AIWiki
|
|
|
32
32
|
项目内测试: ./aiwiki-test
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
把下面这段复制给 Codex、Claude Code、QClaw、OpenClaw 或其他本地 AI 编程助手:
|
|
35
|
+
2. 把下面这段复制给 Codex、Claude Code、QClaw、OpenClaw 或其他本地 AI 编程助手:
|
|
36
|
+
|
|
37
|
+
发送前,请把所有 `<替换成我的 AIWiki 知识库路径>` 替换成你自己的本地文件夹路径,例如 `D:\AIWiki` 或 `~/AIWiki`。不要把这个占位符原样留在命令里。
|
|
36
38
|
|
|
37
39
|
```text
|
|
38
40
|
请帮我安装并配置 AIWiki。
|
|
@@ -44,6 +46,8 @@ macOS/Linux: ~/AIWiki
|
|
|
44
46
|
|
|
45
47
|
<替换成我的 AIWiki 知识库路径>
|
|
46
48
|
|
|
49
|
+
运行命令前,请把下面所有 `<替换成我的 AIWiki 知识库路径>` 替换成我的真实本地文件夹路径。如果我没有替换,占位符仍然原样存在,请停止并向我询问真实路径。
|
|
50
|
+
|
|
47
51
|
请运行这些命令:
|
|
48
52
|
|
|
49
53
|
npm install -g @itradingai/aiwiki@latest
|
|
@@ -64,25 +68,14 @@ aiwiki status --path "<替换成我的 AIWiki 知识库路径>"
|
|
|
64
68
|
5. 下一步应该怎么用
|
|
65
69
|
```
|
|
66
70
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
- `aiwiki agent sync --yes`:把 AIWiki 的 skill / command 同步到本机支持的 AI 助手环境。
|
|
70
|
-
- `aiwiki agent sync --path "<workspace>" --yes`:在知识库根目录写入指导,让以后进入这个目录的 Agent 也知道要优先使用 `aiwiki` 命令。
|
|
71
|
-
|
|
72
|
-
同步后,如果助手没有立刻识别 AIWiki,需要重启或重新加载助手。
|
|
71
|
+
3. 如有需要,重启或重新加载你的 AI 助手。
|
|
73
72
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
完成后,AI 助手应该能确认:
|
|
77
|
-
|
|
78
|
-
- `aiwiki` 已安装,并能输出版本号
|
|
79
|
-
- 知识库路径已经创建,并通过 `aiwiki doctor`
|
|
80
|
-
- Agent 接入状态是 `installed`、`updated` 或 `current`
|
|
81
|
-
- `aiwiki agent sync --path` 已经写入知识库根指导
|
|
82
|
-
- `aiwiki status` 能返回当前知识库状态和下一步动作
|
|
73
|
+
如果 Agent 同步失败,可以提交 [Agent Integration issue](https://github.com/iTradingAI/aiwiki/issues/new?template=agent_integration.md),并附上 `aiwiki agent check --json` 和 `aiwiki doctor --path "<workspace>"` 的输出。
|
|
83
74
|
|
|
84
75
|
## 第一次使用
|
|
85
76
|
|
|
77
|
+
第一次试用 AIWiki,建议先按 [使用指南](docs/USAGE.zh-CN.md#3-入库资料) 里的短路径跑一遍。
|
|
78
|
+
|
|
86
79
|
### 入库资料
|
|
87
80
|
|
|
88
81
|
对 AI 助手说:
|
|
@@ -135,12 +128,7 @@ aiwiki query "<主题>"
|
|
|
135
128
|
aiwiki lint --json
|
|
136
129
|
```
|
|
137
130
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
```bash
|
|
141
|
-
aiwiki lint --fix-empty-dirs --json
|
|
142
|
-
aiwiki lint --json
|
|
143
|
-
```
|
|
131
|
+
如果你想让助手进一步整理知识库,可以参考 [使用指南](docs/USAGE.zh-CN.md) 里的检查流程。
|
|
144
132
|
|
|
145
133
|
## AIWiki 会生成什么
|
|
146
134
|
|
|
@@ -183,9 +171,10 @@ AIWiki 的作用是让 AI 助手把读过的资料整理成本地 Markdown 知
|
|
|
183
171
|
|
|
184
172
|
## 典型场景
|
|
185
173
|
|
|
186
|
-
-
|
|
187
|
-
-
|
|
188
|
-
-
|
|
174
|
+
- **建立个人研究 Wiki**:把文章、PDF、文件和笔记沉淀成本地 Markdown 知识库。
|
|
175
|
+
- **把有价值的阅读变成可复用想法**:沉淀概念、观点、选题、大纲和后续创作素材。
|
|
176
|
+
- **给 Codex、Claude Code 或 QClaw 一个稳定的本地知识层**:让助手回答前先查自己的 AIWiki。
|
|
177
|
+
- **保留可追溯的知识链路**:Raw、Source Card、Wiki Entry 和运行记录都能回查。
|
|
189
178
|
|
|
190
179
|
## 工作原理
|
|
191
180
|
|
|
@@ -226,39 +215,38 @@ AIWiki 不是简单拼接两套方法。
|
|
|
226
215
|
|
|
227
216
|
## Agent 接入
|
|
228
217
|
|
|
229
|
-
AIWiki 面向 AI
|
|
218
|
+
AIWiki 面向 AI 助手驱动的工作流。`aiwiki agent sync --yes` 会把 AIWiki 的说明同步到支持的本地助手环境;`aiwiki agent sync --path "<workspace>" --yes` 会在知识库根目录写入指导,让进入该目录的助手优先使用 AIWiki 命令。
|
|
230
219
|
|
|
231
|
-
|
|
220
|
+
完整的命令优先协作约定见 [Agent 接入说明](docs/AGENT_HANDOFF.zh-CN.md)。
|
|
232
221
|
|
|
233
|
-
|
|
234
|
-
- Claude Code
|
|
235
|
-
- QClaw
|
|
236
|
-
- OpenClaw
|
|
222
|
+
## Obsidian / Dataview
|
|
237
223
|
|
|
238
|
-
|
|
224
|
+
AIWiki 写的是普通 Markdown 和 frontmatter。
|
|
239
225
|
|
|
240
|
-
|
|
241
|
-
aiwiki agent sync --yes
|
|
242
|
-
aiwiki agent sync --path "<workspace>" --yes
|
|
243
|
-
aiwiki agent check --json
|
|
244
|
-
aiwiki agent check --path "<workspace>" --json
|
|
245
|
-
```
|
|
226
|
+
Obsidian 是推荐查看界面,但不是硬依赖。Dataview 是可选 dashboard 增强。
|
|
246
227
|
|
|
247
|
-
|
|
228
|
+
AIWiki 不会自动安装 Dataview,也不会修改 `.obsidian`。
|
|
248
229
|
|
|
249
|
-
|
|
250
|
-
aiwiki prompt agent
|
|
251
|
-
```
|
|
230
|
+
## 安全和隐私
|
|
252
231
|
|
|
253
|
-
|
|
232
|
+
- AIWiki 写入本地 Markdown 和 JSON 文件。
|
|
233
|
+
- AIWiki 不会上传你的知识库。
|
|
234
|
+
- AIWiki 不内置 LLM。
|
|
235
|
+
- AIWiki 不会自行爬取网页。
|
|
236
|
+
- `npm install` 不会修改 AI 助手配置。
|
|
237
|
+
- Agent 接入需要显式运行 `aiwiki agent sync`。
|
|
254
238
|
|
|
255
|
-
##
|
|
239
|
+
## 当前状态
|
|
256
240
|
|
|
257
|
-
AIWiki
|
|
241
|
+
AIWiki 当前聚焦于:
|
|
258
242
|
|
|
259
|
-
|
|
243
|
+
- 单个本地 AIWiki 知识库
|
|
244
|
+
- 本地 Markdown 和 frontmatter 检索
|
|
245
|
+
- AI 助手驱动的入库流程
|
|
246
|
+
- Source Card 和 Wiki Entry
|
|
247
|
+
- `context`、`query`、`lint`、`status`、`doctor` 等工作流
|
|
260
248
|
|
|
261
|
-
|
|
249
|
+
语义搜索、向量索引、浏览器剪藏、RSS 采集和企业权限管理目前都不在当前范围内。
|
|
262
250
|
|
|
263
251
|
## 设计边界
|
|
264
252
|
|
|
@@ -283,9 +271,10 @@ AIWiki 由 iTradingAI 开源维护。
|
|
|
283
271
|
|
|
284
272
|
中文用户可以扫码加入交流群,或关注公众号获取更新、案例和使用讨论。
|
|
285
273
|
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
274
|
+
<p>
|
|
275
|
+
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/join-group.png" alt="加入微信群" width="220" />
|
|
276
|
+
<img src="https://raw.githubusercontent.com/iTradingAI/aiwiki/main/docs/assets/wechat-official-account.png" alt="微信公众号" width="220" />
|
|
277
|
+
</p>
|
|
289
278
|
|
|
290
279
|
## 文档
|
|
291
280
|
|
package/docs/README.md
CHANGED
|
@@ -30,6 +30,7 @@ This docs folder keeps the public guides short and task-oriented. The main READM
|
|
|
30
30
|
|
|
31
31
|
- [`../examples/demo-run/`](../examples/demo-run/) records input files, CLI commands, and outputs from a regenerated run.
|
|
32
32
|
- [`../examples/obsidian-vault-sample/`](../examples/obsidian-vault-sample/) is a sample Markdown vault showing the current core-first artifact contract.
|
|
33
|
+
- [`../examples/public-trial-scenarios/`](../examples/public-trial-scenarios/) contains three public-trial scenarios: article research, topic planning, and project decision memory.
|
|
33
34
|
|
|
34
35
|
## Core Workflow
|
|
35
36
|
|
|
@@ -42,6 +43,8 @@ AI assistant reads a source
|
|
|
42
43
|
|
|
43
44
|
For public trials, keep the first loop to one source and one question: setup, ingest, inspect the run artifacts, query/context reuse, lint/doctor, and a short feedback note.
|
|
44
45
|
|
|
46
|
+
The scenario pack gives users copyable sample inputs, expected generated artifacts, reuse prompts, long-term maintenance value, and WeChat-group-ready copy for each trial path.
|
|
47
|
+
|
|
45
48
|
## Important Boundaries
|
|
46
49
|
|
|
47
50
|
AIWiki does not fetch webpages, call an LLM, install Obsidian plugins, run vector search, or manage multiple knowledge bases. The host assistant reads sources; AIWiki validates, writes, links, queries, and checks the local Markdown knowledge base.
|
package/docs/SHOWCASE.md
CHANGED
|
@@ -103,5 +103,29 @@ The assistant should use the returned JSON, including match reasons and quality
|
|
|
103
103
|
|
|
104
104
|
- [`../examples/demo-run/`](../examples/demo-run/) records input files, commands, and CLI outputs.
|
|
105
105
|
- [`../examples/obsidian-vault-sample/`](../examples/obsidian-vault-sample/) is a generated sample vault.
|
|
106
|
+
- [`../examples/public-trial-scenarios/`](../examples/public-trial-scenarios/) provides three runnable public-trial examples: article research memory, topic planning memory, and project decision memory.
|
|
106
107
|
|
|
107
108
|
The sample does not rely on crawling, vector search, RAG-over-wiki, or Pro automation. It shows the real base CLI file contract.
|
|
109
|
+
|
|
110
|
+
## Public Trial Scenario Pack
|
|
111
|
+
|
|
112
|
+
Use the scenario pack when a user asks, "What should I try first?"
|
|
113
|
+
|
|
114
|
+
Each scenario includes:
|
|
115
|
+
|
|
116
|
+
- sample input material
|
|
117
|
+
- base CLI commands
|
|
118
|
+
- expected Raw, Source Card, Wiki Entry, and run artifacts
|
|
119
|
+
- a query/context reuse prompt
|
|
120
|
+
- why the knowledge is worth maintaining over time
|
|
121
|
+
- WeChat-group-ready usage copy
|
|
122
|
+
|
|
123
|
+
Suggested order:
|
|
124
|
+
|
|
125
|
+
```text
|
|
126
|
+
article research memory
|
|
127
|
+
-> topic planning memory
|
|
128
|
+
-> project decision memory
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
This order starts from the most common reading workflow, moves into content reuse, and ends with team/project memory. It keeps the trial focused on local Markdown knowledge reuse instead of adding crawling, vectors, or Pro features.
|
package/docs/USAGE.md
CHANGED
|
@@ -17,6 +17,8 @@ AIWiki does not fetch webpages and does not call an LLM. The host assistant read
|
|
|
17
17
|
|
|
18
18
|
Copy this prompt into your assistant:
|
|
19
19
|
|
|
20
|
+
Before sending it, replace every `<replace-with-my-aiwiki-path>` with your own local folder path, such as `D:\AIWiki` or `~/AIWiki`. Do not leave the placeholder in the commands.
|
|
21
|
+
|
|
20
22
|
```text
|
|
21
23
|
Please install and configure AIWiki for me.
|
|
22
24
|
|
|
@@ -27,6 +29,8 @@ Use this knowledge base path:
|
|
|
27
29
|
|
|
28
30
|
<replace-with-my-aiwiki-path>
|
|
29
31
|
|
|
32
|
+
Replace every `<replace-with-my-aiwiki-path>` below with my own local folder path before running commands. If I left the placeholder unchanged, stop and ask me for the real path.
|
|
33
|
+
|
|
30
34
|
Run these commands:
|
|
31
35
|
|
|
32
36
|
npm install -g @itradingai/aiwiki@latest
|
|
@@ -116,6 +120,26 @@ aiwiki lint --json --path <workspace>
|
|
|
116
120
|
|
|
117
121
|
When the source is a URL, the assistant reads it first and then calls `aiwiki ingest-agent`; AIWiki itself does not crawl the page.
|
|
118
122
|
|
|
123
|
+
### Public-trial scenarios
|
|
124
|
+
|
|
125
|
+
If you do not have a source ready, use the runnable scenario pack:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
aiwiki setup --path ./aiwiki-trial --yes
|
|
129
|
+
aiwiki ingest-file --file examples/public-trial-scenarios/input/article-research.md --path ./aiwiki-trial
|
|
130
|
+
aiwiki query "source card" --path ./aiwiki-trial
|
|
131
|
+
aiwiki context "article research" --path ./aiwiki-trial
|
|
132
|
+
aiwiki lint --json --path ./aiwiki-trial
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
The pack includes:
|
|
136
|
+
|
|
137
|
+
- article research memory
|
|
138
|
+
- topic planning memory
|
|
139
|
+
- project decision memory
|
|
140
|
+
|
|
141
|
+
See [`../examples/public-trial-scenarios/`](../examples/public-trial-scenarios/) for sample inputs, expected generated artifacts, query/context reuse examples, maintenance value, and WeChat-group-ready copy for each scenario.
|
|
142
|
+
|
|
119
143
|
Tell your assistant:
|
|
120
144
|
|
|
121
145
|
```text
|
package/docs/USAGE.zh-CN.md
CHANGED
|
@@ -17,6 +17,8 @@ AIWiki 不抓网页,也不调用 LLM。宿主 AI 助手负责读取和理解
|
|
|
17
17
|
|
|
18
18
|
复制这段给你的 AI 助手:
|
|
19
19
|
|
|
20
|
+
发送前,请把所有 `<替换成我的 AIWiki 知识库路径>` 替换成你自己的本地文件夹路径,例如 `D:\AIWiki` 或 `~/AIWiki`。不要把这个占位符原样留在命令里。
|
|
21
|
+
|
|
20
22
|
```text
|
|
21
23
|
请帮我安装并配置 AIWiki。
|
|
22
24
|
|
|
@@ -27,6 +29,8 @@ AIWiki 不抓网页,也不调用 LLM。宿主 AI 助手负责读取和理解
|
|
|
27
29
|
|
|
28
30
|
<替换成我的 AIWiki 知识库路径>
|
|
29
31
|
|
|
32
|
+
运行命令前,请把下面所有 `<替换成我的 AIWiki 知识库路径>` 替换成我的真实本地文件夹路径。如果我没有替换,占位符仍然原样存在,请停止并向我询问真实路径。
|
|
33
|
+
|
|
30
34
|
请运行这些命令:
|
|
31
35
|
|
|
32
36
|
npm install -g @itradingai/aiwiki@latest
|
package/docs/development-log.md
CHANGED
|
@@ -2,6 +2,76 @@
|
|
|
2
2
|
|
|
3
3
|
This log records queue-driven AIWiki development milestones that should remain visible to future maintainers, not only in automation chat history.
|
|
4
4
|
|
|
5
|
+
## 2026-06-11 - Repository trust and README P0/P1 polish
|
|
6
|
+
|
|
7
|
+
Status: implemented and locally verified. Demo GIF recording is intentionally deferred until the P0/P1 documentation and repository trust pass is complete.
|
|
8
|
+
|
|
9
|
+
Version published: `@itradingai/aiwiki@0.2.23`
|
|
10
|
+
|
|
11
|
+
### Goal
|
|
12
|
+
|
|
13
|
+
Close the high-priority public-facing issues identified after the README rewrite:
|
|
14
|
+
|
|
15
|
+
- keep GitHub About, npm metadata, and README positioning aligned;
|
|
16
|
+
- make README shorter and push detailed procedures into docs;
|
|
17
|
+
- document security and privacy boundaries;
|
|
18
|
+
- add CI coverage for build, test, and package inspection;
|
|
19
|
+
- make Agent sync failure reporting easier;
|
|
20
|
+
- keep WeChat community entry visible without overwhelming the README.
|
|
21
|
+
|
|
22
|
+
### Implemented
|
|
23
|
+
|
|
24
|
+
- Compressed the English and Chinese README quick-start flows around the assistant-driven install prompt.
|
|
25
|
+
- Moved detailed first-use, lint, and trial-route guidance toward the usage guides.
|
|
26
|
+
- Added Agent sync failure issue guidance with `agent check` and `doctor` evidence.
|
|
27
|
+
- Added Security and Privacy and Current Status sections in both README files.
|
|
28
|
+
- Refined practical scenarios around research, reusable ideas, assistant context, and traceability.
|
|
29
|
+
- Reduced community QR display size while keeping the WeChat group and official account visible.
|
|
30
|
+
- Clarified that `<replace-with-my-aiwiki-path>` and `<替换成我的 AIWiki 知识库路径>` are placeholders users must replace with their own local folder path before running commands.
|
|
31
|
+
- Added `.github/workflows/ci.yml` to run build, tests, and `npm pack --dry-run` on Node 20, 22, and 24.
|
|
32
|
+
- Fixed the npm test runner command so CI does not depend on shell glob expansion or newer Node test-runner glob behavior.
|
|
33
|
+
|
|
34
|
+
### Verification
|
|
35
|
+
|
|
36
|
+
- Local README/doc link check: passed, `broken links: 0`.
|
|
37
|
+
- `npm run release:check`: passed, 61 tests.
|
|
38
|
+
- `npm pack --dry-run --json`: passed for `@itradingai/aiwiki@0.2.22`, 90 files, package size approximately 106 kB.
|
|
39
|
+
- Pack inspection confirmed `docs/assets`, `aiwiki-hero`, `aiwiki-logo`, `join-group`, and `wechat-official-account` are still excluded from the npm tarball.
|
|
40
|
+
- GitHub About description was updated to match npm/README positioning.
|
|
41
|
+
- Initial CI run exposed Node 20 incompatibility in the quoted test glob; the test helper was added, and the follow-up GitHub Actions CI run passed on Node 20, 22, and 24.
|
|
42
|
+
- Prepublish remote tarball smoke passed on `170.106.73.197` in `/tmp/aiwiki-0.2.23-prepublish-20260611T150959`.
|
|
43
|
+
- GitHub Actions Publish npm run `27330327862` succeeded and npm registry reported `0.2.23`.
|
|
44
|
+
- Postpublish remote npm smoke passed on `170.106.73.197` in `/tmp/aiwiki-0.2.23-postpublish-20260611T151405`.
|
|
45
|
+
|
|
46
|
+
## 2026-06-11 - README hero and logo asset refresh
|
|
47
|
+
|
|
48
|
+
Status: implemented and locally verified. This pass targets GitHub raw image delivery only; no npm publication.
|
|
49
|
+
|
|
50
|
+
### Goal
|
|
51
|
+
|
|
52
|
+
Replace the older README hero visual with gpt-image-2 generated brand assets that better match the current AIWiki positioning:
|
|
53
|
+
|
|
54
|
+
- golden angular AIWiki logo with a four-point star in the center;
|
|
55
|
+
- clear source inputs: Web link, PDF, and Notes;
|
|
56
|
+
- assistant-driven reading and understanding;
|
|
57
|
+
- AIWiki writing structured Markdown;
|
|
58
|
+
- local Markdown knowledge vault and later `aiwiki context` retrieval;
|
|
59
|
+
- separate English and Chinese README hero images.
|
|
60
|
+
|
|
61
|
+
### Implemented
|
|
62
|
+
|
|
63
|
+
- Replaced `docs/assets/aiwiki-hero.png` with the English gpt-image-2 generated hero.
|
|
64
|
+
- Added `docs/assets/aiwiki-hero.zh-CN.png` as the Chinese gpt-image-2 generated hero.
|
|
65
|
+
- Added `docs/assets/aiwiki-logo.png` cropped from the gpt-image-2 generated English hero for future brand reuse.
|
|
66
|
+
- Updated `README.zh-CN.md` to use the Chinese raw GitHub hero URL: `docs/assets/aiwiki-hero.zh-CN.png`.
|
|
67
|
+
- Kept README images out of the npm package; README files reference GitHub raw URLs instead.
|
|
68
|
+
|
|
69
|
+
### Verification
|
|
70
|
+
|
|
71
|
+
- Local README/doc link check: passed, `broken links: 0`.
|
|
72
|
+
- `npm run release:check`: passed, 61 tests.
|
|
73
|
+
- `npm pack --dry-run`: passed for `@itradingai/aiwiki@0.2.22`; confirmed `docs/assets`, `aiwiki-hero`, `aiwiki-logo`, `join-group`, and `wechat-official-account` were not included in the npm tarball.
|
|
74
|
+
|
|
5
75
|
## 2026-06-11 - Public trial path and feedback loop
|
|
6
76
|
|
|
7
77
|
Status: implemented and locally verified. Pre-delivery remote tarball smoke, GitHub push, Trusted Publishing, registry verification, and post-publish remote sanity are required before queue completion.
|
|
@@ -402,3 +472,19 @@ Then update the queue through `published`, `remote_verified`, and `done`.
|
|
|
402
472
|
- Lint actions are advisory only. Do not make `archive`, `reingest`, `mark_reviewed`, or related actions mutate files without a separate explicit task.
|
|
403
473
|
- Keep lint local-file-only. Do not add crawling, vector search, RAG-over-wiki, RBAC, RSS, scheduled collection, or browser plugins under this queue item.
|
|
404
474
|
- The original working tree had unrelated `skill/SKILL.md` changes. Publication must use a clean commit export until that WIP is resolved.
|
|
475
|
+
|
|
476
|
+
## 2026-06-12 - Public trial scenario pack
|
|
477
|
+
|
|
478
|
+
### Goal
|
|
479
|
+
|
|
480
|
+
Help first-time AIWiki users try three concrete workflows without inventing their own source material.
|
|
481
|
+
|
|
482
|
+
### Implemented
|
|
483
|
+
|
|
484
|
+
- Added `examples/public-trial-scenarios/` with article research, topic planning, and project decision memory samples.
|
|
485
|
+
- Documented the base CLI commands, expected generated artifacts, query/context reuse prompt, long-term maintenance value, and WeChat-group-ready copy for each scenario.
|
|
486
|
+
- Linked the scenario pack from README, docs home, Usage, and Showcase.
|
|
487
|
+
|
|
488
|
+
### Boundaries
|
|
489
|
+
|
|
490
|
+
- No crawler, WeChat reader, browser plugin, vector search, RAG-over-wiki, RBAC, RSS, scheduled collection, Pro command, or new dependency was added.
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# Public Trial Scenario Pack
|
|
2
|
+
|
|
3
|
+
This pack gives first-time AIWiki users three small, repeatable scenarios.
|
|
4
|
+
Each one uses only the base CLI: `setup`, `ingest-file`, `query`, `context`,
|
|
5
|
+
and `lint`.
|
|
6
|
+
|
|
7
|
+
Run any scenario in a temporary knowledge base:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
aiwiki setup --path ./aiwiki-trial --yes
|
|
11
|
+
aiwiki ingest-file --file examples/public-trial-scenarios/input/article-research.md --path ./aiwiki-trial
|
|
12
|
+
aiwiki query "source card" --path ./aiwiki-trial
|
|
13
|
+
aiwiki context "source card" --path ./aiwiki-trial
|
|
14
|
+
aiwiki lint --json --path ./aiwiki-trial
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
For a clean comparison, create a new temporary workspace per scenario or remove
|
|
18
|
+
only your own temporary `./aiwiki-trial` folder after inspecting it.
|
|
19
|
+
|
|
20
|
+
## Scenario 1: Article Research Memory
|
|
21
|
+
|
|
22
|
+
Input material:
|
|
23
|
+
|
|
24
|
+
- [`input/article-research.md`](input/article-research.md)
|
|
25
|
+
|
|
26
|
+
Use this when you read an article and want the assistant to preserve the core
|
|
27
|
+
argument, evidence boundary, and later writing angles.
|
|
28
|
+
|
|
29
|
+
Commands:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
aiwiki ingest-file --file examples/public-trial-scenarios/input/article-research.md --path ./aiwiki-trial
|
|
33
|
+
aiwiki query "source card" --path ./aiwiki-trial
|
|
34
|
+
aiwiki context "article research" --path ./aiwiki-trial
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Expected generated artifacts:
|
|
38
|
+
|
|
39
|
+
- `02-raw/articles/article-research.md`
|
|
40
|
+
- `03-sources/article-cards/article-research.md`
|
|
41
|
+
- `05-wiki/source-knowledge/article-research.md`
|
|
42
|
+
- `09-runs/<run-id>/processing-summary.md`
|
|
43
|
+
|
|
44
|
+
Reuse example:
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
Ask: What does AIWiki remember about preserving source evidence?
|
|
48
|
+
Expected: query/context should surface the article-research Wiki Entry and explain why it matched.
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Why maintain it over time:
|
|
52
|
+
|
|
53
|
+
Article notes become useful only when they are searchable and traceable months
|
|
54
|
+
later. This scenario shows how a one-off reading note becomes reusable research
|
|
55
|
+
memory.
|
|
56
|
+
|
|
57
|
+
WeChat group copy:
|
|
58
|
+
|
|
59
|
+
```text
|
|
60
|
+
AIWiki can turn an article note into a traceable Source Card and Wiki Entry. Try it with one article, then ask the knowledge base what evidence and writing angles it preserved.
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Scenario 2: Topic Planning Memory
|
|
64
|
+
|
|
65
|
+
Input material:
|
|
66
|
+
|
|
67
|
+
- [`input/topic-planning.md`](input/topic-planning.md)
|
|
68
|
+
|
|
69
|
+
Use this when you collect rough topic ideas and want the assistant to turn them
|
|
70
|
+
into reusable planning context instead of another forgotten note.
|
|
71
|
+
|
|
72
|
+
Commands:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
aiwiki ingest-file --file examples/public-trial-scenarios/input/topic-planning.md --path ./aiwiki-trial
|
|
76
|
+
aiwiki query "topic planning" --path ./aiwiki-trial
|
|
77
|
+
aiwiki context "content calendar" --path ./aiwiki-trial
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Expected generated artifacts:
|
|
81
|
+
|
|
82
|
+
- `02-raw/articles/topic-planning.md`
|
|
83
|
+
- `03-sources/article-cards/topic-planning.md`
|
|
84
|
+
- `05-wiki/source-knowledge/topic-planning.md`
|
|
85
|
+
- `09-runs/<run-id>/source-card.md`
|
|
86
|
+
|
|
87
|
+
Reuse example:
|
|
88
|
+
|
|
89
|
+
```text
|
|
90
|
+
Ask: What topic directions are already captured for public trial content?
|
|
91
|
+
Expected: query/context should return the topic-planning entry before the assistant drafts.
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Why maintain it over time:
|
|
95
|
+
|
|
96
|
+
A content queue is easier to improve when old reasons, audiences, and angles are
|
|
97
|
+
still visible. This scenario shows how AIWiki keeps planning memory available
|
|
98
|
+
for future writing.
|
|
99
|
+
|
|
100
|
+
WeChat group copy:
|
|
101
|
+
|
|
102
|
+
```text
|
|
103
|
+
AIWiki can keep topic ideas from becoming scattered chat history. Save a planning note, then ask it which angles are already available before writing.
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Scenario 3: Project Decision Memory
|
|
107
|
+
|
|
108
|
+
Input material:
|
|
109
|
+
|
|
110
|
+
- [`input/project-decision.md`](input/project-decision.md)
|
|
111
|
+
|
|
112
|
+
Use this when a project decision needs to be remembered with constraints,
|
|
113
|
+
rejected alternatives, and a future check point.
|
|
114
|
+
|
|
115
|
+
Commands:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
aiwiki ingest-file --file examples/public-trial-scenarios/input/project-decision.md --path ./aiwiki-trial
|
|
119
|
+
aiwiki query "decision memory" --path ./aiwiki-trial
|
|
120
|
+
aiwiki context "constraints and rejected alternatives" --path ./aiwiki-trial
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Expected generated artifacts:
|
|
124
|
+
|
|
125
|
+
- `02-raw/articles/project-decision.md`
|
|
126
|
+
- `03-sources/article-cards/project-decision.md`
|
|
127
|
+
- `05-wiki/source-knowledge/project-decision.md`
|
|
128
|
+
- `09-runs/<run-id>/wiki-entry.md`
|
|
129
|
+
|
|
130
|
+
Reuse example:
|
|
131
|
+
|
|
132
|
+
```text
|
|
133
|
+
Ask: Why did the project choose a local Markdown knowledge base first?
|
|
134
|
+
Expected: query/context should surface the decision note and preserve the stated constraints.
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Why maintain it over time:
|
|
138
|
+
|
|
139
|
+
Decision memory prevents the team from re-litigating the same tradeoffs. This
|
|
140
|
+
scenario shows how AIWiki keeps the reason, boundary, and next review together.
|
|
141
|
+
|
|
142
|
+
WeChat group copy:
|
|
143
|
+
|
|
144
|
+
```text
|
|
145
|
+
AIWiki is useful for more than articles: it can preserve project decisions with constraints and rejected alternatives so the next assistant starts from context.
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## What Success Looks Like
|
|
149
|
+
|
|
150
|
+
After each scenario, inspect:
|
|
151
|
+
|
|
152
|
+
```text
|
|
153
|
+
02-raw/articles/
|
|
154
|
+
03-sources/article-cards/
|
|
155
|
+
05-wiki/source-knowledge/
|
|
156
|
+
09-runs/
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Then run:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
aiwiki lint --json --path ./aiwiki-trial
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
The scenario is successful when AIWiki creates a raw record, Source Card, Wiki
|
|
166
|
+
Entry, run summary, and query/context can find the scenario topic again.
|
|
167
|
+
|
|
168
|
+
## Boundaries
|
|
169
|
+
|
|
170
|
+
These examples do not use crawling, WeChat reading, browser plugins, vector
|
|
171
|
+
search, RAG-over-wiki, RBAC, RSS, scheduled collection, Pro commands, or new
|
|
172
|
+
dependencies. If the source is a webpage, the host assistant reads it first and
|
|
173
|
+
then passes understood content into AIWiki.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Article Research Memory
|
|
2
|
+
|
|
3
|
+
## Source
|
|
4
|
+
|
|
5
|
+
A team is evaluating how to keep research notes useful after an assistant reads
|
|
6
|
+
an article. The current problem is not reading speed. The problem is that useful
|
|
7
|
+
claims, source context, and writing angles disappear into chat history.
|
|
8
|
+
|
|
9
|
+
## Key Points
|
|
10
|
+
|
|
11
|
+
- The source should be saved with enough traceability to revisit later.
|
|
12
|
+
- The summary should separate what the source says from what the assistant
|
|
13
|
+
inferred.
|
|
14
|
+
- The reusable entry should be easy to query before writing a future article.
|
|
15
|
+
- A first trial should use one article and one question, not a large migration.
|
|
16
|
+
|
|
17
|
+
## Reuse Prompt
|
|
18
|
+
|
|
19
|
+
Before drafting a post about AI knowledge bases, ask:
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
What does AIWiki remember about preserving source evidence?
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The answer should reuse the stored Source Card and Wiki Entry instead of relying
|
|
26
|
+
on memory from the current chat only.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Project Decision Memory
|
|
2
|
+
|
|
3
|
+
## Decision
|
|
4
|
+
|
|
5
|
+
Start with a local Markdown knowledge base before adding heavier retrieval
|
|
6
|
+
systems.
|
|
7
|
+
|
|
8
|
+
## Constraints
|
|
9
|
+
|
|
10
|
+
- Users need to inspect and edit the generated files.
|
|
11
|
+
- The first public trial must work without a hosted service.
|
|
12
|
+
- The assistant, not AIWiki, reads webpages and understands source content.
|
|
13
|
+
- Query and context should stay local and explainable.
|
|
14
|
+
|
|
15
|
+
## Rejected Alternatives
|
|
16
|
+
|
|
17
|
+
- Browser plugin first: too much installation and permission surface for the
|
|
18
|
+
first trial.
|
|
19
|
+
- Vector database first: useful later, but it hides the file contract before
|
|
20
|
+
users trust the workflow.
|
|
21
|
+
- Scheduled RSS collection first: it solves volume before the basic reuse loop
|
|
22
|
+
is proven.
|
|
23
|
+
|
|
24
|
+
## Review Trigger
|
|
25
|
+
|
|
26
|
+
Revisit this decision after users can reliably complete setup, ingest one
|
|
27
|
+
source, query it later, and report where the workflow feels unclear.
|
|
28
|
+
|
|
29
|
+
## Reuse Prompt
|
|
30
|
+
|
|
31
|
+
Before proposing a new storage or retrieval feature, ask:
|
|
32
|
+
|
|
33
|
+
```text
|
|
34
|
+
Why did the project choose a local Markdown knowledge base first?
|
|
35
|
+
```
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Topic Planning Memory
|
|
2
|
+
|
|
3
|
+
## Planning Note
|
|
4
|
+
|
|
5
|
+
The public trial needs content that helps users understand what AIWiki is for.
|
|
6
|
+
The strongest topics are practical and problem-first:
|
|
7
|
+
|
|
8
|
+
- "Why bookmarks are not enough for AI reading workflows"
|
|
9
|
+
- "How to turn one article into reusable assistant context"
|
|
10
|
+
- "What to check during a 10-minute AIWiki trial"
|
|
11
|
+
|
|
12
|
+
## Audience
|
|
13
|
+
|
|
14
|
+
Users who already ask AI assistants to read links, summarize documents, or
|
|
15
|
+
prepare writing material, but who lose the result after the chat ends.
|
|
16
|
+
|
|
17
|
+
## Success Signal
|
|
18
|
+
|
|
19
|
+
A useful topic plan should explain what the user can try immediately, what files
|
|
20
|
+
AIWiki creates, and how query/context helps the next writing session.
|
|
21
|
+
|
|
22
|
+
## Reuse Prompt
|
|
23
|
+
|
|
24
|
+
Before planning the next public-trial article, ask:
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
What topic directions are already captured for public trial content?
|
|
28
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itradingai/aiwiki",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.24",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Local Markdown knowledge base for AI assistants. Save what your AI reads, ask it later, and keep everything local.",
|
|
6
6
|
"license": "MIT",
|
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
},
|
|
68
68
|
"scripts": {
|
|
69
69
|
"build": "tsc -p tsconfig.json",
|
|
70
|
-
"test": "npm run build && node
|
|
70
|
+
"test": "npm run build && node scripts/run-tests.mjs",
|
|
71
71
|
"check": "npm run test",
|
|
72
72
|
"release:check": "npm test && node scripts/release-check.mjs",
|
|
73
73
|
"prepack": "npm run build"
|