@devflow-tools/knowledge-engine 0.3.2 → 0.4.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 +40 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @devflow-tools/knowledge-engine
|
|
2
|
+
|
|
3
|
+
Knowledge engine for DevFlow — search and sync technical documentation from official sources.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @devflow-tools/knowledge-engine
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { KnowledgeEngine } from '@devflow-tools/knowledge-engine';
|
|
15
|
+
|
|
16
|
+
const engine = new KnowledgeEngine({ projectRoot: '/path/to/project' });
|
|
17
|
+
|
|
18
|
+
// Search knowledge base
|
|
19
|
+
const results = await engine.search('React useEffect cleanup');
|
|
20
|
+
|
|
21
|
+
// Sync docs from sources
|
|
22
|
+
await engine.syncDocs('react');
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Features
|
|
26
|
+
|
|
27
|
+
- **Documentation search** — BM25-based keyword search across synced docs
|
|
28
|
+
- **Multi-source sync** — pull docs from GitHub, official sites
|
|
29
|
+
- **Markdown conversion** — HTML to Markdown with heading-preserving chunking
|
|
30
|
+
|
|
31
|
+
## API
|
|
32
|
+
|
|
33
|
+
- `KnowledgeEngine` — main class
|
|
34
|
+
- `.search(query)` — search knowledge base
|
|
35
|
+
- `.syncDocs(pluginName?)` — sync documentation for a plugin
|
|
36
|
+
- `.getSources()` — list available knowledge sources
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devflow-tools/knowledge-engine",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"clean": "rm -rf dist"
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@devflow-tools/sdk": "^0.
|
|
20
|
+
"@devflow-tools/sdk": "^0.4.0",
|
|
21
21
|
"turndown": "^7.2.4"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
@@ -28,5 +28,5 @@
|
|
|
28
28
|
"files": [
|
|
29
29
|
"dist"
|
|
30
30
|
],
|
|
31
|
-
"gitHead": "
|
|
31
|
+
"gitHead": "c76bcf3a2bb8ac12b871738d6661979eb45090c6"
|
|
32
32
|
}
|