@itradingai/aiwiki 0.2.23 → 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 +4 -0
- package/docs/README.md +3 -0
- package/docs/SHOWCASE.md +24 -0
- package/docs/USAGE.md +20 -0
- package/docs/development-log.md +21 -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 +1 -1
package/README.md
CHANGED
|
@@ -158,6 +158,7 @@ See:
|
|
|
158
158
|
|
|
159
159
|
- [`examples/demo-run/`](examples/demo-run/)
|
|
160
160
|
- [`examples/obsidian-vault-sample/`](examples/obsidian-vault-sample/)
|
|
161
|
+
- [`examples/public-trial-scenarios/`](examples/public-trial-scenarios/)
|
|
161
162
|
|
|
162
163
|
## Why AIWiki
|
|
163
164
|
|
|
@@ -178,6 +179,8 @@ Instead of saving links and losing context, you get Markdown files that your ass
|
|
|
178
179
|
- **Give Codex, Claude Code, or QClaw a stable local knowledge layer** it can query before answering.
|
|
179
180
|
- **Keep summaries traceable** with raw records, source cards, Wiki Entries, and run records.
|
|
180
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.
|
|
183
|
+
|
|
181
184
|
## How It Works
|
|
182
185
|
|
|
183
186
|
```text
|
|
@@ -291,6 +294,7 @@ For Chinese users, scan the QR codes below to join the WeChat group or follow th
|
|
|
291
294
|
- [Agent Handoff](docs/AGENT_HANDOFF.md)
|
|
292
295
|
- [FAQ](docs/FAQ.md)
|
|
293
296
|
- [Showcase](docs/SHOWCASE.md)
|
|
297
|
+
- [Public Trial Scenarios](examples/public-trial-scenarios/)
|
|
294
298
|
- [Trial Feedback Template](docs/TRIAL_FEEDBACK_TEMPLATE.md)
|
|
295
299
|
- [Roadmap](docs/ROADMAP.md)
|
|
296
300
|
- [Release Notes](docs/RELEASE.md)
|
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
|
@@ -120,6 +120,26 @@ aiwiki lint --json --path <workspace>
|
|
|
120
120
|
|
|
121
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.
|
|
122
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
|
+
|
|
123
143
|
Tell your assistant:
|
|
124
144
|
|
|
125
145
|
```text
|
package/docs/development-log.md
CHANGED
|
@@ -6,6 +6,8 @@ This log records queue-driven AIWiki development milestones that should remain v
|
|
|
6
6
|
|
|
7
7
|
Status: implemented and locally verified. Demo GIF recording is intentionally deferred until the P0/P1 documentation and repository trust pass is complete.
|
|
8
8
|
|
|
9
|
+
Version published: `@itradingai/aiwiki@0.2.23`
|
|
10
|
+
|
|
9
11
|
### Goal
|
|
10
12
|
|
|
11
13
|
Close the high-priority public-facing issues identified after the README rewrite:
|
|
@@ -37,6 +39,9 @@ Close the high-priority public-facing issues identified after the README rewrite
|
|
|
37
39
|
- Pack inspection confirmed `docs/assets`, `aiwiki-hero`, `aiwiki-logo`, `join-group`, and `wechat-official-account` are still excluded from the npm tarball.
|
|
38
40
|
- GitHub About description was updated to match npm/README positioning.
|
|
39
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`.
|
|
40
45
|
|
|
41
46
|
## 2026-06-11 - README hero and logo asset refresh
|
|
42
47
|
|
|
@@ -467,3 +472,19 @@ Then update the queue through `published`, `remote_verified`, and `done`.
|
|
|
467
472
|
- Lint actions are advisory only. Do not make `archive`, `reingest`, `mark_reviewed`, or related actions mutate files without a separate explicit task.
|
|
468
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.
|
|
469
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