bible-note 0.4.7 → 0.5.0

package/README.md

@@ -247,7 +247,47 @@ per-chapter verse counts.
 | `BibleNoteStorageManager` | type | Storage adapter contract |
 | `BibleNoteColorScheme` | type | `'light' | 'dark'` |
 
-`dist/` and `types/` here are generated by `npm run pack` from the sources under
-`src/` — edit those, not the build output. This file, `package.json` and
-`LICENSE` are maintained by hand and are the only files in this folder that git
-tracks.
+## Knowledge files
+
+The package ships two markdown files describing itself, generated on every
+build:
+
+| File | For |
+| --- | --- |
+| `bible-note/knowledge/development.md` | Developers: architecture, installation, every prop and hook grouped by feature, datasets and lookup managers, persistence, Electron integration, working on the editor, and a full API reference generated from the type declarations |
+| `bible-note/knowledge/ui-rag.md` | A retrieval (RAG) pipeline behind an in-app assistant: end-user help for the editor UI — formatting, the slash menu, mentions, Bible verses, the lookup panel, inserting content, shortcuts, import/export, comments, settings |
+
+Both are exposed through `exports`, so they resolve like any other subpath:
+
+```js
+import { readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+
+const ragPath = fileURLToPath(import.meta.resolve("bible-note/knowledge/ui-rag.md"));
+// CommonJS: require.resolve("bible-note/knowledge/ui-rag.md")
+const corpus = await readFile(ragPath, "utf8");
+```
+
+`ui-rag.md` is pre-chunked. It opens with YAML front matter (`package`,
+`version`, `chunks`), and every `## ` heading starts one self-contained chunk.
+The heading is a breadcrumb (`## Mentions › Mention a person with @`), and the
+line under it is an HTML comment holding the chunk's metadata as JSON:
+
+```markdown
+## Mentions › Mention a person with @
+
+<!-- chunk {"id":"ui/mentions/mention-a-person-with","section":"Mentions","title":"Mention a person with @","tags":["mentions","names"],"source":"knowledge/ui/04-mentions.md","package":"bible-note@0.5.0"} -->
+
+Type @ followed by a few letters of the name…
+```
+
+Split on `^## ` (a markdown-header splitter does this out of the box), parse
+`<!-- chunk (.*) -->` for metadata, and index the rest. Chunk `id`s are stable
+across releases as long as the section heading is unchanged; every chunk is
+under 4,000 characters. The text is written for the person using the editor and
+names buttons as they appear on screen.
+
+`dist/`, `types/` and `knowledge/` here are generated by `npm run pack` from the
+sources under `src/` and `knowledge/` — edit those, not the build output. This
+file, `package.json` and `LICENSE` are maintained by hand and are the only files
+in this folder that git tracks.