lumina-wiki 0.3.0 → 0.5.0
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 +39 -202
- package/README.vi.md +215 -0
- package/README.zh.md +215 -0
- package/package.json +1 -1
- package/src/installer/template-engine.js +3 -1
- package/src/scripts/lint.mjs +67 -3
- package/src/scripts/schemas.mjs +1 -0
- package/src/scripts/wiki.mjs +66 -0
- package/src/skills/core/check/SKILL.md +25 -51
- package/src/skills/core/check/references/lint-checks.md +52 -0
- package/src/skills/core/edit/SKILL.md +12 -13
- package/src/skills/core/ingest/SKILL.md +45 -33
- package/src/skills/core/ingest/references/dedup-policy.md +75 -0
- package/src/skills/core/ingest/references/pdf-preprocessing.md +30 -0
- package/src/skills/core/reset/SKILL.md +12 -12
- package/src/skills/packs/reading/chapter-ingest/SKILL.md +25 -3
- package/src/skills/packs/reading/character-track/SKILL.md +28 -4
- package/src/skills/packs/reading/plot-recap/SKILL.md +5 -0
- package/src/skills/packs/reading/theme-map/SKILL.md +26 -1
- package/src/skills/packs/research/discover/SKILL.md +52 -10
- package/src/skills/packs/research/discover/references/ranking-signals.md +60 -0
- package/src/skills/packs/research/discover/references/source-modes.md +50 -0
- package/src/skills/packs/research/prefill/SKILL.md +74 -2
- package/src/skills/packs/research/setup/SKILL.md +7 -0
- package/src/skills/packs/research/survey/SKILL.md +14 -0
- package/src/templates/README.md +8 -3
- package/src/templates/_lumina/schema/page-templates.md +1 -0
- package/src/tools/fetch_wikipedia.py +10 -1
- package/src/tools/init_discovery.py +32 -9
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<p align="center">
|
|
1
|
+
<p align="center" lang="en">
|
|
2
2
|
<img src="assets/lumina-logo.png" width="250" alt="Lumina-Wiki Logo">
|
|
3
3
|
</p>
|
|
4
4
|
|
|
@@ -23,14 +23,11 @@ Lumina-Wiki is a ready-to-use implementation of the **[LLM-Wiki vision](https://
|
|
|
23
23
|
</p>
|
|
24
24
|
|
|
25
25
|
<p align="center">
|
|
26
|
-
<a href="
|
|
26
|
+
English • <a href="README.vi.md" lang="vi">Tiếng Việt</a> • <a href="README.zh.md" lang="zh">简体中文</a>
|
|
27
27
|
</p>
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
<a name="english"></a>
|
|
32
|
-
***English README***
|
|
33
|
-
|
|
34
31
|
## 1. The Core Workflow
|
|
35
32
|
|
|
36
33
|
Lumina-Wiki operates on a simple principle: separate your raw materials from the AI's structured knowledge.
|
|
@@ -65,7 +62,7 @@ The installer will guide you through a quick setup, including selecting optional
|
|
|
65
62
|
If you installed the `research` pack, some skills need API keys to search online. Run the setup skill to configure them. In your AI chat window:
|
|
66
63
|
|
|
67
64
|
> **You:**
|
|
68
|
-
> `/lumi-setup`
|
|
65
|
+
> `/lumi-research-setup`
|
|
69
66
|
|
|
70
67
|
The agent will guide you through an interactive setup to save your keys to a local `.env` file.
|
|
71
68
|
|
|
@@ -98,7 +95,7 @@ Lumina creates a workspace with a clear purpose for each directory.
|
|
|
98
95
|
| `raw/sources/` | Place your primary documents (PDFs, articles) here. | You |
|
|
99
96
|
| `raw/notes/` | Your personal, unstructured notes and ideas. | You |
|
|
100
97
|
| `raw/assets/` | Images or other assets for your notes. | You |
|
|
101
|
-
| `raw/discovered/`| *(Research Pack)* Papers found by `/lumi-discover` are saved here. | Agent |
|
|
98
|
+
| `raw/discovered/`| *(Research Pack)* Papers found by `/lumi-research-discover` are saved here. | Agent |
|
|
102
99
|
| **`wiki/`** | **The Agent's Brain.** The agent **writes** structured knowledge here. | **Agent** |
|
|
103
100
|
| `wiki/sources/` | AI-generated summaries for each document in `raw/sources`. | Agent |
|
|
104
101
|
| `wiki/concepts/` | Core ideas and definitions are extracted into individual pages. | Agent |
|
|
@@ -118,13 +115,31 @@ Lumina creates a workspace with a clear purpose for each directory.
|
|
|
118
115
|
|
|
119
116
|
**Note:** You generally do not need to modify the System Folders.
|
|
120
117
|
|
|
118
|
+
### **Browsing Your Wiki with Obsidian (Optional)**
|
|
119
|
+
|
|
120
|
+
[Obsidian](https://obsidian.md) is the recommended visual companion for Lumina-Wiki. Because the wiki uses native Obsidian `[[wikilinks]]`, you get a full graph view, backlinks panel, and property queries out of the box.
|
|
121
|
+
|
|
122
|
+
**Point your vault at the project root** — not just the `wiki/` subfolder. The root contains `index.md`, `log.md`, and cross-links between `wiki/` pages and `raw/` source files that only resolve when Obsidian can see both directories.
|
|
123
|
+
|
|
124
|
+
**Recommended setup after `npx lumina-wiki install`:**
|
|
125
|
+
|
|
126
|
+
1. Obsidian → **Open folder as vault** → select the project root.
|
|
127
|
+
2. **Settings → Files & links → Excluded files** — add:
|
|
128
|
+
- `_lumina/`, `.claude/`, `.cursor/`, `.agents/`, `.git/`, `wiki/graph/`
|
|
129
|
+
- Agent entry-point stubs: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `QWEN.md` — they only redirect to `README.md` and would otherwise add empty nodes to the graph view. Keep `README.md` itself visible: it is the canonical schema reference.
|
|
130
|
+
3. **Settings → Files & links**:
|
|
131
|
+
- Use `[[Wikilinks]]`: **on**
|
|
132
|
+
- New link format: **Shortest path when possible**
|
|
133
|
+
- Default attachment location: `In the folder specified below` → `raw/assets/`
|
|
134
|
+
4. **Core plugins to enable:** Graph view, Backlinks, Outgoing links, Tags, Properties, Outline.
|
|
135
|
+
5. *(Optional)* Community plugin **Dataview** — lets you query pages by frontmatter fields like `type`, `importance`, `confidence`, and `date_added`.
|
|
136
|
+
|
|
137
|
+
> The `wiki/graph/` folder contains `edges.jsonl` and `citations.jsonl` (machine-readable data files, not markdown). Excluding it keeps the graph view clean.
|
|
138
|
+
|
|
121
139
|
---
|
|
122
140
|
|
|
123
141
|
## 5. Available Skills and Tools (v0.1)
|
|
124
142
|
|
|
125
|
-
<details>
|
|
126
|
-
<summary>Click to see the full list of available Skills and the Tools that power them.</summary>
|
|
127
|
-
|
|
128
143
|
### Skills (User Commands)
|
|
129
144
|
|
|
130
145
|
These are the commands you can use in your chat with the AI.
|
|
@@ -137,14 +152,14 @@ These are the commands you can use in your chat with the AI.
|
|
|
137
152
|
| | `/lumi-edit` | Requests a manual edit to a wiki page. |
|
|
138
153
|
| | `/lumi-check` | Lints the wiki for errors (broken links, etc.). |
|
|
139
154
|
| | `/lumi-reset` | Safely resets parts of the wiki. |
|
|
140
|
-
| **Research**| `/lumi-discover` | Discovers and ranks relevant research papers. |
|
|
141
|
-
| | `/lumi-survey` | Creates a survey/summary from existing knowledge. |
|
|
142
|
-
| | `/lumi-prefill` | Seeds the wiki with foundational concepts to avoid duplicates. |
|
|
143
|
-
| | `/lumi-setup` | Helps configure API keys for research tools. |
|
|
144
|
-
| **Reading** | `/lumi-chapter-ingest`| Ingests a book chapter by chapter. |
|
|
145
|
-
| | `/lumi-character-track`| Tracks characters and their relationships in a story. |
|
|
146
|
-
| | `/lumi-theme-map` | Identifies and maps out themes in a narrative. |
|
|
147
|
-
| | `/lumi-plot-recap` | Provides a progressive recap of the plot. |
|
|
155
|
+
| **Research**| `/lumi-research-discover` | Discovers and ranks relevant research papers. |
|
|
156
|
+
| | `/lumi-research-survey` | Creates a survey/summary from existing knowledge. |
|
|
157
|
+
| | `/lumi-research-prefill` | Seeds the wiki with foundational concepts to avoid duplicates. |
|
|
158
|
+
| | `/lumi-research-setup` | Helps configure API keys for research tools. |
|
|
159
|
+
| **Reading** | `/lumi-reading-chapter-ingest`| Ingests a book chapter by chapter. |
|
|
160
|
+
| | `/lumi-reading-character-track`| Tracks characters and their relationships in a story. |
|
|
161
|
+
| | `/lumi-reading-theme-map` | Identifies and maps out themes in a narrative. |
|
|
162
|
+
| | `/lumi-reading-plot-recap` | Provides a progressive recap of the plot. |
|
|
148
163
|
|
|
149
164
|
### Tools (The Engine Under the Hood)
|
|
150
165
|
|
|
@@ -156,11 +171,9 @@ These are the scripts that the agent's skills use to perform actions.
|
|
|
156
171
|
| | `lint.mjs` | Linter used by `/lumi-check` to find errors. |
|
|
157
172
|
| | `reset.mjs` | The script for safely deleting content. |
|
|
158
173
|
| | `schemas.mjs` | The single source of truth for all wiki structures and rules. |
|
|
159
|
-
| **`_lumina/tools/`** | `discover.py` | *(Research Pack)* Powers the `/lumi-discover` skill. |
|
|
174
|
+
| **`_lumina/tools/`** | `discover.py` | *(Research Pack)* Powers the `/lumi-research-discover` skill. |
|
|
160
175
|
| | `fetch_*.py` | *(Research Pack)* A set of tools to fetch data from APIs like ArXiv, Wikipedia, etc. |
|
|
161
176
|
|
|
162
|
-
</details>
|
|
163
|
-
|
|
164
177
|
---
|
|
165
178
|
|
|
166
179
|
## 6. What's Coming Next
|
|
@@ -183,8 +196,7 @@ The current release is **v0.2** (preview). The full plan lives in [`ROADMAP.md`]
|
|
|
183
196
|
|
|
184
197
|
## 7. Contributing & License
|
|
185
198
|
|
|
186
|
-
|
|
187
|
-
<summary>🛠️ Local Development (for contributors)</summary>
|
|
199
|
+
### 🛠️ Local Development (for contributors)
|
|
188
200
|
|
|
189
201
|
If you want to contribute to the `lumina-wiki` installer itself:
|
|
190
202
|
```bash
|
|
@@ -196,185 +208,10 @@ npm ci
|
|
|
196
208
|
# 2. Run Tests
|
|
197
209
|
npm run test:all
|
|
198
210
|
```
|
|
199
|
-
</details>
|
|
200
|
-
|
|
201
|
-
**License:** [MIT](LICENSE) © Lưu Trọng Hiếu.
|
|
202
|
-
|
|
203
|
-
---
|
|
204
|
-
---
|
|
205
|
-
|
|
206
|
-
<a name="vietnamese"></a>
|
|
207
|
-
***README Tiếng Việt***
|
|
208
|
-
|
|
209
|
-
> **Where Knowledge Starts to Glow.**
|
|
210
|
-
>
|
|
211
|
-
> Khối Tri thức được duy trì bởi LLM dành cho nghiên cứu kỹ thuật.
|
|
212
|
-
|
|
213
|
-
## 1. Luồng làm việc cốt lõi
|
|
214
|
-
|
|
215
|
-
Lumina-Wiki hoạt động dựa trên một nguyên tắc đơn giản: tách biệt tài liệu thô của bạn khỏi khối kiến thức có cấu trúc của AI.
|
|
216
|
-
|
|
217
|
-
```text
|
|
218
|
-
+-------------------------+ /lumi-ingest +---------------------------+
|
|
219
|
-
| ĐẦU VÀO CỦA BẠN | ---------------------> | BỘ NÃO CỦA AGENT |
|
|
220
|
-
| (Thư mục raw/) | | (Thư mục wiki/) |
|
|
221
|
-
| | <--------------------- | |
|
|
222
|
-
| - bai-bao.pdf | /lumi-ask | - bai-bao.md (tóm tắt) |
|
|
223
|
-
| - ghi-chu.txt | | - khai-niem-a.md |
|
|
224
|
-
+-------------------------+ +---------------------------+
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
1. **Bạn Cung cấp:** Đặt các tài liệu (PDF, ghi chú) của bạn vào thư mục `raw/`.
|
|
228
|
-
2. **Agent Xây dựng:** Sử dụng các lệnh trong cuộc hội thoại với AI (như `/lumi-ingest`) để yêu cầu agent đọc từ `raw/` và xây dựng một wiki có cấu trúc, liên kết chặt chẽ trong thư mục `wiki/`.
|
|
229
|
-
3. **Bạn Khai thác:** Đặt câu hỏi (sử dụng `/lumi-ask`) trực tiếp vào "bộ não" của agent trong `wiki/` để nhận được câu trả lời nhanh và phù hợp với ngữ cảnh hơn.
|
|
230
|
-
|
|
231
|
-
## 2. Bắt đầu
|
|
232
|
-
|
|
233
|
-
### **Bước 1: Cài đặt**
|
|
234
|
-
Cài đặt không gian làm việc wiki vào dự án hiện tại của bạn bằng một lệnh duy nhất:
|
|
235
|
-
|
|
236
|
-
```bash
|
|
237
|
-
npx lumina-wiki install
|
|
238
|
-
```
|
|
239
|
-
> **Lưu ý cho người dùng Windows:** Để có trải nghiệm tốt nhất, bạn nên [bật Chế độ nhà phát triển (Developer Mode)](https://learn.microsoft.com/vi-vn/windows/apps/get-started/enable-your-device-for-development) để trình cài đặt có thể sử dụng symlink một cách chính xác. Nếu Developer Mode bị tắt, trình cài đặt sẽ chuyển sang sao chép các file skill; chức năng vẫn hoạt động nhưng sẽ không lý tưởng bằng cho việc cập nhật.
|
|
240
|
-
|
|
241
|
-
Trình cài đặt sẽ hướng dẫn bạn qua một vài bước thiết lập nhanh, bao gồm cả việc lựa chọn các **Gói (Packs)** tùy chọn như `research` (nghiên cứu) và `reading` (đọc hiểu).
|
|
242
|
-
|
|
243
|
-
### **Bước 2 (Tùy chọn): Cấu hình Gói Research**
|
|
244
|
-
Nếu bạn đã cài đặt gói `research`, một số kỹ năng sẽ cần API key để tìm kiếm trực tuyến. Hãy chạy kỹ năng setup để cấu hình chúng. Trong cuộc trò chuyện với AI:
|
|
245
|
-
|
|
246
|
-
> **Bạn:**
|
|
247
|
-
> `/lumi-setup`
|
|
248
|
-
|
|
249
|
-
Agent sẽ hướng dẫn bạn qua một quy trình cài đặt tương tác để lưu các key của bạn vào file `.env` cục bộ.
|
|
250
|
-
|
|
251
|
-
## 3. Các lệnh đầu tiên của bạn (Kỹ năng cốt lõi)
|
|
252
|
-
|
|
253
|
-
Tương tác với wiki của bạn bằng cách sử dụng các lệnh này trong giao diện trò chuyện với AI Agent (ví dụ: Gemini CLI, Claude, v.v.).
|
|
254
211
|
|
|
255
|
-
|
|
256
|
-
- `/lumi-init`: Quét thư mục `raw/` và thực hiện xây dựng wiki lần đầu.
|
|
257
|
-
- `/lumi-ingest [đường/dẫn/tới/file]`: Xử lý một tài liệu mới và tích hợp nó vào cơ sở kiến thức.
|
|
212
|
+
## 8. Other Languages
|
|
258
213
|
|
|
259
|
-
|
|
260
|
-
-
|
|
261
|
-
- `/lumi-edit [đường/dẫn/tới/trang/wiki]`: Yêu cầu thay đổi hoặc sửa lỗi cho một trang wiki cụ thể.
|
|
262
|
-
- `/lumi-check`: Kiểm tra toàn bộ wiki để tìm lỗi (liên kết hỏng, trang mồ côi, v.v.).
|
|
214
|
+
- [Tiếng Việt (Vietnamese)](README.vi.md)
|
|
215
|
+
- [简体中文 (Chinese)](README.zh.md)
|
|
263
216
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
## 4. Hướng dẫn cấu trúc thư mục
|
|
269
|
-
|
|
270
|
-
Lumina tạo ra một không gian làm việc với mục đích rõ ràng cho từng thư mục.
|
|
271
|
-
|
|
272
|
-
### **Thư mục chính (Không gian làm việc hàng ngày của bạn)**
|
|
273
|
-
|
|
274
|
-
| Đường dẫn | Mục đích | Quản lý bởi |
|
|
275
|
-
| :--- | :--- | :--- |
|
|
276
|
-
| **`raw/`** | **Thư viện đầu vào bất biến của bạn.** Agent **chỉ đọc** từ đây. | **Bạn** |
|
|
277
|
-
| `raw/sources/` | Đặt các tài liệu chính của bạn (PDF, bài báo) tại đây. | Bạn |
|
|
278
|
-
| `raw/notes/` | Các ghi chú, ý tưởng cá nhân chưa có cấu trúc của bạn. | Bạn |
|
|
279
|
-
| `raw/assets/` | Hình ảnh hoặc các tài sản khác cho ghi chú của bạn. | Bạn |
|
|
280
|
-
| `raw/discovered/`| *(Gói Research)* Các bài báo do `/lumi-discover` tìm thấy sẽ được lưu ở đây. | Agent |
|
|
281
|
-
| **`wiki/`** | **Bộ não của Agent.** Agent **ghi** kiến thức có cấu trúc vào đây. | **Agent** |
|
|
282
|
-
| `wiki/sources/` | Các bản tóm tắt do AI tạo cho mỗi tài liệu trong `raw/sources`. | Agent |
|
|
283
|
-
| `wiki/concepts/` | Các ý tưởng, định nghĩa cốt lõi được trích xuất thành các trang riêng lẻ. | Agent |
|
|
284
|
-
| `wiki/people/` | Hồ sơ của các tác giả, nhà nghiên cứu, v.v. | Agent |
|
|
285
|
-
| `wiki/outputs/` | Các câu trả lời chi tiết từ `/lumi-ask` được lưu lại để tham khảo. | Agent |
|
|
286
|
-
| `wiki/index.md` | Bảng mục lục chính cho toàn bộ wiki của bạn. | Agent |
|
|
287
|
-
| `...` | *(Các thư mục thực thể khác như `foundations/`, `characters/` xuất hiện cùng các gói)* | Agent |
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
### **Thư mục hệ thống (Do Lumina quản lý)**
|
|
291
|
-
|
|
292
|
-
| Đường dẫn | Mục đích | Quản lý bởi |
|
|
293
|
-
| :--- | :--- | :--- |
|
|
294
|
-
| **`_lumina/`** | Engine cốt lõi, script và cấu hình cho wiki. | **Hệ thống** |
|
|
295
|
-
| **`.agents/`** | Chứa tất cả các `skills` (kỹ năng) mà agent có thể sử dụng. | **Hệ thống** |
|
|
296
|
-
| `...` | *(Các file ẩn khác như `.claude/`, `.gitignore`)* | **Hệ thống** |
|
|
297
|
-
|
|
298
|
-
**Lưu ý:** Bạn thường không cần phải sửa đổi các Thư mục hệ thống.
|
|
299
|
-
|
|
300
|
-
---
|
|
301
|
-
|
|
302
|
-
## 5. Các Kỹ năng và Công cụ có sẵn (v0.1)
|
|
303
|
-
|
|
304
|
-
<details>
|
|
305
|
-
<summary>Nhấn để xem danh sách đầy đủ các Kỹ năng và Công cụ hỗ trợ.</summary>
|
|
306
|
-
|
|
307
|
-
### Skills (Lệnh người dùng)
|
|
308
|
-
|
|
309
|
-
Đây là những lệnh bạn có thể sử dụng khi trò chuyện với AI.
|
|
310
|
-
|
|
311
|
-
| Gói | Skill | Mục đích |
|
|
312
|
-
| :--- | :--- | :--- |
|
|
313
|
-
| **Core** | `/lumi-init` | Khởi tạo wiki từ tất cả các file trong `raw/`. |
|
|
314
|
-
| | `/lumi-ingest` | Xử lý một tài liệu mới và đưa vào wiki. |
|
|
315
|
-
| | `/lumi-ask` | Đặt câu hỏi dựa trên toàn bộ cơ sở kiến thức. |
|
|
316
|
-
| | `/lumi-edit` | Yêu cầu chỉnh sửa thủ công một trang wiki. |
|
|
317
|
-
| | `/lumi-check` | Kiểm tra lỗi trong wiki (liên kết hỏng, v.v.). |
|
|
318
|
-
| | `/lumi-reset` | Xóa các phần của wiki một cách an toàn. |
|
|
319
|
-
| **Research**| `/lumi-discover` | Khám phá và xếp hạng các bài báo nghiên cứu liên quan. |
|
|
320
|
-
| | `/lumi-survey` | Tạo một bài tổng quan/khảo sát từ kiến thức hiện có. |
|
|
321
|
-
| | `/lumi-prefill` | Tạo trước các khái niệm nền tảng để tránh trùng lặp. |
|
|
322
|
-
| | `/lumi-setup` | Giúp cấu hình API key cho các công cụ nghiên cứu. |
|
|
323
|
-
| **Reading** | `/lumi-chapter-ingest`| Nạp kiến thức sách theo từng chương. |
|
|
324
|
-
| | `/lumi-character-track`| Theo dõi các nhân vật và mối quan hệ của họ trong truyện. |
|
|
325
|
-
| | `/lumi-theme-map` | Xác định và lập bản đồ các chủ đề trong một câu chuyện. |
|
|
326
|
-
| | `/lumi-plot-recap` | Cung cấp một bản tóm tắt tuần tự của cốt truyện. |
|
|
327
|
-
|
|
328
|
-
### Tools (Engine chạy nền)
|
|
329
|
-
|
|
330
|
-
Đây là các script mà kỹ năng của agent sử dụng để thực hiện hành động.
|
|
331
|
-
|
|
332
|
-
| Vị trí | Tool | Vai trò |
|
|
333
|
-
| :--- | :--- | :--- |
|
|
334
|
-
| **`_lumina/scripts/`** | `wiki.mjs` | **Engine cốt lõi.** Xử lý tất cả các hoạt động ghi/sửa/liên kết trong `wiki/`. |
|
|
335
|
-
| | `lint.mjs` | Trình kiểm tra lỗi được `/lumi-check` sử dụng. |
|
|
336
|
-
| | `reset.mjs` | Script để xóa nội dung một cách an toàn. |
|
|
337
|
-
| | `schemas.mjs` | Nguồn chân lý duy nhất cho tất cả các cấu trúc và quy tắc của wiki. |
|
|
338
|
-
| **`_lumina/tools/`** | `discover.py` | *(Gói Research)* Cung cấp sức mạnh cho kỹ năng `/lumi-discover`. |
|
|
339
|
-
| | `fetch_*.py` | *(Gói Research)* Một bộ công cụ để lấy dữ liệu từ các API như ArXiv, Wikipedia, v.v. |
|
|
340
|
-
|
|
341
|
-
</details>
|
|
342
|
-
|
|
343
|
-
---
|
|
344
|
-
|
|
345
|
-
## 6. Lộ trình sắp tới
|
|
346
|
-
|
|
347
|
-
Phiên bản hiện tại là **v0.2** (preview). Kế hoạch đầy đủ ở [`ROADMAP.md`](./ROADMAP.md). Những hạng mục chính:
|
|
348
|
-
|
|
349
|
-
**v1.0.0 — Bản ổn định đầu tiên**
|
|
350
|
-
- **Daily search & fetch** — watchlist (`_lumina/config/watchlist.yml`) chạy theo lịch; paper mới từ arXiv / Semantic Scholar tự động đáp xuống `raw/discovered/<ngày>/`.
|
|
351
|
-
- Skill mới `/lumi-daily` để triage những gì vừa thu thập kể từ lần chạy trước.
|
|
352
|
-
- Khoá ổn định bề mặt v0.1 (CLI flags, exit codes, tên trường schema).
|
|
353
|
-
- CI matrix đa nền tảng (macOS + Linux + Windows, Node 20 + 22).
|
|
354
|
-
|
|
355
|
-
**v2.0.0 — Mở rộng nguồn paper cho Research Pack**
|
|
356
|
-
- **Nguồn paper mới:** OpenAlex, Unpaywall, CORE (Ưu tiên 1) → OpenReview, Hugging Face Papers, Papers With Code (Ưu tiên 2) → Crossref, DOAJ, RSS từ các blog research lab (Ưu tiên 3).
|
|
357
|
-
- **Đánh giá paper:** skill mới `/lumi-rank` đưa các chỉ số influential-citation count, xếp hạng theo lĩnh vực, Scite support/contrast, và Altmetric vào block `ranking:` trong frontmatter.
|
|
358
|
-
|
|
359
|
-
**Muốn đóng góp?** Chọn bất kỳ hạng mục chưa tick trong `ROADMAP.md`, mở issue để nhận, rồi gửi PR. Các fetcher nguồn paper đều tuân theo cùng pattern trong `src/tools/` (CLI + JSON, không async, exit codes `0/2/3`) nên rất phù hợp cho lần contribute đầu tiên. Xem hướng dẫn dev cục bộ bên dưới.
|
|
360
|
-
|
|
361
|
-
---
|
|
362
|
-
|
|
363
|
-
## 7. Đóng góp & Giấy phép
|
|
364
|
-
|
|
365
|
-
<details>
|
|
366
|
-
<summary>🛠️ Phát triển cục bộ (dành cho người đóng góp)</summary>
|
|
367
|
-
|
|
368
|
-
Nếu bạn muốn đóng góp cho trình cài đặt `lumina-wiki`:
|
|
369
|
-
```bash
|
|
370
|
-
# 1. Clone & Cài đặt Dependencies
|
|
371
|
-
git clone https://github.com/tronghieu/lumina-wiki.git
|
|
372
|
-
cd lumina-wiki
|
|
373
|
-
npm ci
|
|
374
|
-
|
|
375
|
-
# 2. Chạy Tests
|
|
376
|
-
npm run test:all
|
|
377
|
-
```
|
|
378
|
-
</details>
|
|
379
|
-
|
|
380
|
-
**Giấy phép:** [MIT](LICENSE) © Lưu Trọng Hiếu.
|
|
217
|
+
**License:** [MIT](LICENSE) © Lưu Trọng Hiếu.
|
package/README.vi.md
ADDED
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
<p align="center" lang="vi">
|
|
2
|
+
<img src="assets/lumina-logo.png" width="250" alt="Lumina-Wiki Logo">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# Lumina-Wiki
|
|
6
|
+
|
|
7
|
+
> **Where Knowledge Starts to Glow.**
|
|
8
|
+
>
|
|
9
|
+
> Khối Tri thức được duy trì bởi LLM dành cho nghiên cứu kỹ thuật.
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<img alt="License" src="https://img.shields.io/badge/License-MIT-blue.svg"/>
|
|
13
|
+
<img alt="Node.js" src="https://img.shields.io/badge/Node.js-%3E%3D20-blue.svg"/>
|
|
14
|
+
<img alt="Python" src="https://img.shields.io/badge/Python-3.9+-yellow.svg"/>
|
|
15
|
+
<img alt="Skills" src="https://img.shields.io/badge/Skills-14-purple.svg"/>
|
|
16
|
+
<br>
|
|
17
|
+
<img alt="Powered by" src="https://img.shields.io/badge/Powered%20by-grey?style=flat"/>
|
|
18
|
+
<img alt="Claude" src="https://img.shields.io/badge/-Claude%20Code-orange?style=flat"/>
|
|
19
|
+
<img alt="Codex" src="https://img.shields.io/badge/-Codex-blueviolet?style=flat"/>
|
|
20
|
+
<img alt="Gemini" src="https://img.shields.io/badge/-Gemini-4285F4?style=flat"/>
|
|
21
|
+
</p>
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<a href="README.md" lang="en">English</a> • Tiếng Việt • <a href="README.zh.md" lang="zh">简体中文</a>
|
|
25
|
+
</p>
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 1. Luồng làm việc cốt lõi
|
|
30
|
+
|
|
31
|
+
Lumina-Wiki hoạt động dựa trên một nguyên tắc đơn giản: tách biệt tài liệu thô của bạn khỏi khối kiến thức có cấu trúc của AI.
|
|
32
|
+
|
|
33
|
+
```text
|
|
34
|
+
+-------------------------+ /lumi-ingest +---------------------------+
|
|
35
|
+
| ĐẦU VÀO CỦA BẠN | ---------------------> | BỘ NÃO CỦA AGENT |
|
|
36
|
+
| (Thư mục raw/) | | (Thư mục wiki/) |
|
|
37
|
+
| | <--------------------- | |
|
|
38
|
+
| - bai-bao.pdf | /lumi-ask | - bai-bao.md (tóm tắt) |
|
|
39
|
+
| - ghi-chu.txt | | - khai-niem-a.md |
|
|
40
|
+
+-------------------------+ +---------------------------+
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
1. **Bạn Cung cấp:** Đặt các tài liệu (PDF, ghi chú) của bạn vào thư mục `raw/`.
|
|
44
|
+
2. **Agent Xây dựng:** Sử dụng các lệnh trong cuộc hội thoại với AI (như `/lumi-ingest`) để yêu cầu agent đọc từ `raw/` và xây dựng một wiki có cấu trúc, liên kết chặt chẽ trong thư mục `wiki/`.
|
|
45
|
+
3. **Bạn Khai thác:** Đặt câu hỏi (sử dụng `/lumi-ask`) trực tiếp vào "bộ não" của agent trong `wiki/` để nhận được câu trả lời nhanh và phù hợp với ngữ cảnh hơn.
|
|
46
|
+
|
|
47
|
+
## 2. Bắt đầu
|
|
48
|
+
|
|
49
|
+
### **Bước 1: Cài đặt**
|
|
50
|
+
Cài đặt không gian làm việc wiki vào dự án hiện tại của bạn bằng một lệnh duy nhất:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npx lumina-wiki install
|
|
54
|
+
```
|
|
55
|
+
> **Lưu ý cho người dùng Windows:** Để có trải nghiệm tốt nhất, bạn nên [bật Chế độ nhà phát triển (Developer Mode)](https://learn.microsoft.com/vi-vn/windows/apps/get-started/enable-your-device-for-development) để trình cài đặt có thể sử dụng symlink một cách chính xác. Nếu Developer Mode bị tắt, trình cài đặt sẽ chuyển sang sao chép các file skill; chức năng vẫn hoạt động nhưng sẽ không lý tưởng bằng cho việc cập nhật.
|
|
56
|
+
|
|
57
|
+
Trình cài đặt sẽ hướng dẫn bạn qua một vài bước thiết lập nhanh, bao gồm cả việc lựa chọn các **Gói (Packs)** tùy chọn như `research` (nghiên cứu) và `reading` (đọc hiểu).
|
|
58
|
+
|
|
59
|
+
### **Bước 2 (Tùy chọn): Cấu hình Gói Research**
|
|
60
|
+
Nếu bạn đã cài đặt gói `research`, một số kỹ năng sẽ cần API key để tìm kiếm trực tuyến. Hãy chạy kỹ năng setup để cấu hình chúng. Trong cuộc trò chuyện với AI:
|
|
61
|
+
|
|
62
|
+
> **Bạn:**
|
|
63
|
+
> `/lumi-research-setup`
|
|
64
|
+
|
|
65
|
+
Agent sẽ hướng dẫn bạn qua một quy trình cài đặt tương tác để lưu các key của bạn vào file `.env` cục bộ.
|
|
66
|
+
|
|
67
|
+
## 3. Các lệnh đầu tiên của bạn (Kỹ năng cốt lõi)
|
|
68
|
+
|
|
69
|
+
Tương tác với wiki của bạn bằng cách sử dụng các lệnh này trong giao diện trò chuyện với AI Agent (ví dụ: Gemini CLI, Claude, v.v.).
|
|
70
|
+
|
|
71
|
+
**Giai đoạn 1: Nạp và Xây dựng kiến thức**
|
|
72
|
+
- `/lumi-init`: Quét thư mục `raw/` và thực hiện xây dựng wiki lần đầu.
|
|
73
|
+
- `/lumi-ingest [đường/dẫn/tới/file]`: Xử lý một tài liệu mới và tích hợp nó vào cơ sở kiến thức.
|
|
74
|
+
|
|
75
|
+
**Giai đoạn 2: Khai thác và Bảo trì**
|
|
76
|
+
- `/lumi-ask [câu hỏi của bạn]`: Đặt câu hỏi dựa trên toàn bộ cơ sở kiến thức trong `wiki/`.
|
|
77
|
+
- `/lumi-edit [đường/dẫn/tới/trang/wiki]`: Yêu cầu thay đổi hoặc sửa lỗi cho một trang wiki cụ thể.
|
|
78
|
+
- `/lumi-check`: Kiểm tra toàn bộ wiki để tìm lỗi (liên kết hỏng, trang mồ côi, v.v.).
|
|
79
|
+
|
|
80
|
+
*Các kỹ năng bổ sung có thể có sẵn nếu bạn đã cài đặt các gói tùy chọn như `research` hoặc `reading`.*
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## 4. Hướng dẫn cấu trúc thư mục
|
|
85
|
+
|
|
86
|
+
Lumina tạo ra một không gian làm việc với mục đích rõ ràng cho từng thư mục.
|
|
87
|
+
|
|
88
|
+
### **Thư mục chính (Không gian làm việc hàng ngày của bạn)**
|
|
89
|
+
|
|
90
|
+
| Đường dẫn | Mục đích | Quản lý bởi |
|
|
91
|
+
| :--- | :--- | :--- |
|
|
92
|
+
| **`raw/`** | **Thư viện đầu vào bất biến của bạn.** Agent **chỉ đọc** từ đây. | **Bạn** |
|
|
93
|
+
| `raw/sources/` | Đặt các tài liệu chính của bạn (PDF, bài báo) tại đây. | Bạn |
|
|
94
|
+
| `raw/notes/` | Các ghi chú, ý tưởng cá nhân chưa có cấu trúc của bạn. | Bạn |
|
|
95
|
+
| `raw/assets/` | Hình ảnh hoặc các tài sản khác cho ghi chú của bạn. | Bạn |
|
|
96
|
+
| `raw/discovered/`| *(Gói Research)* Các bài báo do `/lumi-research-discover` tìm thấy sẽ được lưu ở đây. | Agent |
|
|
97
|
+
| **`wiki/`** | **Bộ não của Agent.** Agent **ghi** kiến thức có cấu trúc vào đây. | **Agent** |
|
|
98
|
+
| `wiki/sources/` | Các bản tóm tắt do AI tạo cho mỗi tài liệu trong `raw/sources`. | Agent |
|
|
99
|
+
| `wiki/concepts/` | Các ý tưởng, định nghĩa cốt lõi được trích xuất thành các trang riêng lẻ. | Agent |
|
|
100
|
+
| `wiki/people/` | Hồ sơ của các tác giả, nhà nghiên cứu, v.v. | Agent |
|
|
101
|
+
| `wiki/outputs/` | Các câu trả lời chi tiết từ `/lumi-ask` được lưu lại để tham khảo. | Agent |
|
|
102
|
+
| `wiki/index.md` | Bảng mục lục chính cho toàn bộ wiki của bạn. | Agent |
|
|
103
|
+
| `...` | *(Các thư mục thực thể khác như `foundations/`, `characters/` xuất hiện cùng các gói)* | Agent |
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### **Thư mục hệ thống (Do Lumina quản lý)**
|
|
107
|
+
|
|
108
|
+
| Đường dẫn | Mục đích | Quản lý bởi |
|
|
109
|
+
| :--- | :--- | :--- |
|
|
110
|
+
| **`_lumina/`** | Engine cốt lõi, script và cấu hình cho wiki. | **Hệ thống** |
|
|
111
|
+
| **`.agents/`** | Chứa tất cả các `skills` (kỹ năng) mà agent có thể sử dụng. | **Hệ thống** |
|
|
112
|
+
| `...` | *(Các file ẩn khác như `.claude/`, `.gitignore`)* | **Hệ thống** |
|
|
113
|
+
|
|
114
|
+
**Lưu ý:** Bạn thường không cần phải sửa đổi các Thư mục hệ thống.
|
|
115
|
+
|
|
116
|
+
### **Duyệt Wiki với Obsidian (Tùy chọn)**
|
|
117
|
+
|
|
118
|
+
[Obsidian](https://obsidian.md) là ứng dụng đọc wiki được khuyến nghị dùng cùng Lumina-Wiki. Vì wiki dùng cú pháp `[[wikilink]]` gốc của Obsidian, bạn có ngay graph view, backlinks panel và query theo frontmatter mà không cần cấu hình thêm.
|
|
119
|
+
|
|
120
|
+
**Trỏ vault vào thư mục gốc của project** — không phải chỉ vào `wiki/`. Thư mục gốc chứa `index.md`, `log.md`, và các cross-link giữa trang `wiki/` với file gốc trong `raw/` — những link này chỉ resolve được khi Obsidian nhìn thấy cả hai thư mục.
|
|
121
|
+
|
|
122
|
+
**Cấu hình gợi ý sau khi chạy `npx lumina-wiki install`:**
|
|
123
|
+
|
|
124
|
+
1. Obsidian → **Open folder as vault** → chọn thư mục gốc của project.
|
|
125
|
+
2. **Settings → Files & links → Excluded files** — thêm:
|
|
126
|
+
- `_lumina/`, `.claude/`, `.cursor/`, `.agents/`, `.git/`, `wiki/graph/`
|
|
127
|
+
- Các file stub redirect sang README.md: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `QWEN.md` — chỉ trỏ về `README.md` và sẽ tạo node rỗng trong graph view nếu để lại. Giữ `README.md` lại trong vault: đây là tài liệu schema chính.
|
|
128
|
+
3. **Settings → Files & links**:
|
|
129
|
+
- Use `[[Wikilinks]]`: **bật**
|
|
130
|
+
- New link format: **Shortest path when possible**
|
|
131
|
+
- Default attachment location: `In the folder specified below` → `raw/assets/`
|
|
132
|
+
4. **Core plugins nên bật:** Graph view, Backlinks, Outgoing links, Tags, Properties, Outline.
|
|
133
|
+
5. *(Tùy chọn)* Community plugin **Dataview** — cho phép query các trang theo frontmatter như `type`, `importance`, `confidence`, `date_added`.
|
|
134
|
+
|
|
135
|
+
> Thư mục `wiki/graph/` chứa `edges.jsonl` và `citations.jsonl` (dữ liệu máy đọc, không phải markdown). Exclude thư mục này giúp graph view không bị nhiễu.
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 5. Các Kỹ năng và Công cụ có sẵn (v0.1)
|
|
140
|
+
|
|
141
|
+
### Skills (Lệnh người dùng)
|
|
142
|
+
|
|
143
|
+
Đây là những lệnh bạn có thể sử dụng khi trò chuyện với AI.
|
|
144
|
+
|
|
145
|
+
| Gói | Skill | Mục đích |
|
|
146
|
+
| :--- | :--- | :--- |
|
|
147
|
+
| **Core** | `/lumi-init` | Khởi tạo wiki từ tất cả các file trong `raw/`. |
|
|
148
|
+
| | `/lumi-ingest` | Xử lý một tài liệu mới và đưa vào wiki. |
|
|
149
|
+
| | `/lumi-ask` | Đặt câu hỏi dựa trên toàn bộ cơ sở kiến thức. |
|
|
150
|
+
| | `/lumi-edit` | Yêu cầu chỉnh sửa thủ công một trang wiki. |
|
|
151
|
+
| | `/lumi-check` | Kiểm tra lỗi trong wiki (liên kết hỏng, v.v.). |
|
|
152
|
+
| | `/lumi-reset` | Xóa các phần của wiki một cách an toàn. |
|
|
153
|
+
| **Research**| `/lumi-research-discover` | Khám phá và xếp hạng các bài báo nghiên cứu liên quan. |
|
|
154
|
+
| | `/lumi-research-survey` | Tạo một bài tổng quan/khảo sát từ kiến thức hiện có. |
|
|
155
|
+
| | `/lumi-research-prefill` | Tạo trước các khái niệm nền tảng để tránh trùng lặp. |
|
|
156
|
+
| | `/lumi-research-setup` | Giúp cấu hình API key cho các công cụ nghiên cứu. |
|
|
157
|
+
| **Reading** | `/lumi-reading-chapter-ingest`| Nạp kiến thức sách theo từng chương. |
|
|
158
|
+
| | `/lumi-reading-character-track`| Theo dõi các nhân vật và mối quan hệ của họ trong truyện. |
|
|
159
|
+
| | `/lumi-reading-theme-map` | Xác định và lập bản đồ các chủ đề trong một câu chuyện. |
|
|
160
|
+
| | `/lumi-reading-plot-recap` | Cung cấp một bản tóm tắt tuần tự của cốt truyện. |
|
|
161
|
+
|
|
162
|
+
### Tools (Engine chạy nền)
|
|
163
|
+
|
|
164
|
+
Đây là các script mà kỹ năng của agent sử dụng để thực hiện hành động.
|
|
165
|
+
|
|
166
|
+
| Vị trí | Tool | Vai trò |
|
|
167
|
+
| :--- | :--- | :--- |
|
|
168
|
+
| **`_lumina/scripts/`** | `wiki.mjs` | **Engine cốt lõi.** Xử lý tất cả các hoạt động ghi/sửa/liên kết trong `wiki/`. |
|
|
169
|
+
| | `lint.mjs` | Trình kiểm tra lỗi được `/lumi-check` sử dụng. |
|
|
170
|
+
| | `reset.mjs` | Script để xóa nội dung một cách an toàn. |
|
|
171
|
+
| | `schemas.mjs` | Nguồn chân lý duy nhất cho tất cả các cấu trúc và quy tắc của wiki. |
|
|
172
|
+
| **`_lumina/tools/`** | `discover.py` | *(Gói Research)* Cung cấp sức mạnh cho kỹ năng `/lumi-research-discover`. |
|
|
173
|
+
| | `fetch_*.py` | *(Gói Research)* Một bộ công cụ để lấy dữ liệu từ các API như ArXiv, Wikipedia, v.v. |
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 6. Lộ trình sắp tới
|
|
178
|
+
|
|
179
|
+
Phiên bản hiện tại là **v0.2** (preview). Kế hoạch đầy đủ ở [`ROADMAP.md`](./ROADMAP.md). Những hạng mục chính:
|
|
180
|
+
|
|
181
|
+
**v1.0.0 — Bản ổn định đầu tiên**
|
|
182
|
+
- **Daily search & fetch** — watchlist (`_lumina/config/watchlist.yml`) chạy theo lịch; paper mới từ arXiv / Semantic Scholar tự động đáp xuống `raw/discovered/<ngày>/`.
|
|
183
|
+
- Skill mới `/lumi-daily` để triage những gì vừa thu thập kể từ lần chạy trước.
|
|
184
|
+
- Khoá ổn định bề mặt v0.1 (CLI flags, exit codes, tên trường schema).
|
|
185
|
+
- CI matrix đa nền tảng (macOS + Linux + Windows, Node 20 + 22).
|
|
186
|
+
|
|
187
|
+
**v2.0.0 — Mở rộng nguồn paper cho Research Pack**
|
|
188
|
+
- **Nguồn paper mới:** OpenAlex, Unpaywall, CORE (Ưu tiên 1) → OpenReview, Hugging Face Papers, Papers With Code (Ưu tiên 2) → Crossref, DOAJ, RSS từ các blog research lab (Ưu tiên 3).
|
|
189
|
+
- **Đánh giá paper:** skill mới `/lumi-rank` đưa các chỉ số influential-citation count, xếp hạng theo lĩnh vực, Scite support/contrast, và Altmetric vào block `ranking:` trong frontmatter.
|
|
190
|
+
|
|
191
|
+
**Muốn đóng góp?** Chọn bất kỳ hạng mục chưa tick trong `ROADMAP.md`, mở issue để nhận, rồi gửi PR. Các fetcher nguồn paper đều tuân theo cùng pattern trong `src/tools/` (CLI + JSON, no async, exit codes `0/2/3`) nên rất phù hợp cho lần contribute đầu tiên. Xem hướng dẫn dev cục bộ bên dưới.
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## 7. Đóng góp & Giấy phép
|
|
196
|
+
|
|
197
|
+
### 🛠️ Phát triển cục bộ (dành cho người đóng góp)
|
|
198
|
+
|
|
199
|
+
Nếu bạn muốn đóng góp cho trình cài đặt `lumina-wiki`:
|
|
200
|
+
```bash
|
|
201
|
+
# 1. Clone & Cài đặt Dependencies
|
|
202
|
+
git clone https://github.com/tronghieu/lumina-wiki.git
|
|
203
|
+
cd lumina-wiki
|
|
204
|
+
npm ci
|
|
205
|
+
|
|
206
|
+
# 2. Chạy Tests
|
|
207
|
+
npm run test:all
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## 8. Ngôn ngữ khác
|
|
211
|
+
|
|
212
|
+
- [English (Tiếng Anh)](README.md)
|
|
213
|
+
- [简体中文 (Tiếng Trung)](README.zh.md)
|
|
214
|
+
|
|
215
|
+
**Giấy phép:** [MIT](LICENSE) © Lưu Trọng Hiếu.
|