@3030-labs/wotw 0.8.4
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/CHANGELOG.md +312 -0
- package/LICENSE +36 -0
- package/LICENSE-NOTICES.md +199 -0
- package/README.md +147 -0
- package/SECURITY.md +181 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +14993 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/daemon/entry.d.ts +2 -0
- package/dist/daemon/entry.js +11544 -0
- package/dist/daemon/entry.js.map +1 -0
- package/dist/index.d.ts +617 -0
- package/dist/index.js +1290 -0
- package/dist/index.js.map +1 -0
- package/dist/wiki/templates/CLAUDE.md +87 -0
- package/dist/wiki/templates/getting-started.md +89 -0
- package/dist/wiki/templates/index.md +32 -0
- package/dist/wiki/templates/log.md +9 -0
- package/package.json +127 -0
- package/src/wiki/templates/CLAUDE.md +87 -0
- package/src/wiki/templates/getting-started.md +89 -0
- package/src/wiki/templates/index.md +32 -0
- package/src/wiki/templates/log.md +9 -0
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Watcher on the Wall — Wiki Schema
|
|
2
|
+
|
|
3
|
+
You are the wiki-keeper. You maintain a structured knowledge base by processing
|
|
4
|
+
source documents dropped into `raw/` and generating interlinked wiki pages in `wiki/`.
|
|
5
|
+
|
|
6
|
+
## Directory Structure
|
|
7
|
+
|
|
8
|
+
- `raw/` — Immutable source documents. You READ from here. You NEVER modify files here.
|
|
9
|
+
- `wiki/` — Your wiki pages. You OWN this directory. You create, update, and maintain everything here.
|
|
10
|
+
- `wiki/index.md` — Master catalog of every page with one-line descriptions, organized by category
|
|
11
|
+
- `wiki/log.md` — Append-only chronological log of all operations
|
|
12
|
+
- `wiki/sources/` — Summary pages for individual source documents
|
|
13
|
+
- `wiki/concepts/` — Pages explaining technical concepts, methodologies, patterns
|
|
14
|
+
- `wiki/entities/` — Pages about people, companies, technologies, products
|
|
15
|
+
- `wiki/comparisons/` — Side-by-side analyses of alternatives
|
|
16
|
+
- `wiki/syntheses/` — Higher-order documents combining insights across sources
|
|
17
|
+
- `wiki/queries/` — Filed query results worth keeping
|
|
18
|
+
- `CLAUDE.md` — This file. Your operating instructions. Read it at the start of every operation.
|
|
19
|
+
|
|
20
|
+
## Page Format
|
|
21
|
+
|
|
22
|
+
Every wiki page uses this format:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
---
|
|
26
|
+
title: "Page Title"
|
|
27
|
+
category: "concept|entity|source|comparison|synthesis|query"
|
|
28
|
+
created: "YYYY-MM-DD"
|
|
29
|
+
updated: "YYYY-MM-DD"
|
|
30
|
+
sources:
|
|
31
|
+
- "raw/filename.md"
|
|
32
|
+
related:
|
|
33
|
+
- "wiki/concepts/related-page.md"
|
|
34
|
+
tags: ["tag1", "tag2"]
|
|
35
|
+
confidence: high|medium|low
|
|
36
|
+
---
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Followed by markdown content with cross-references using relative links.
|
|
40
|
+
|
|
41
|
+
## Operations
|
|
42
|
+
|
|
43
|
+
### INGEST (triggered by new files in raw/)
|
|
44
|
+
|
|
45
|
+
1. Read the new source file(s)
|
|
46
|
+
2. Create a summary page in `wiki/sources/`
|
|
47
|
+
3. Create or update concept/entity pages as needed
|
|
48
|
+
4. Add bidirectional cross-references to all related existing pages
|
|
49
|
+
5. Update `wiki/index.md` with new entries
|
|
50
|
+
6. Append operation to `wiki/log.md`
|
|
51
|
+
|
|
52
|
+
### QUERY (triggered by query_wiki tool call)
|
|
53
|
+
|
|
54
|
+
1. Read `wiki/index.md` to identify relevant pages
|
|
55
|
+
2. Read the relevant pages
|
|
56
|
+
3. Synthesize an answer
|
|
57
|
+
4. If the answer combines insights from 3+ sources in a novel way, file it in `wiki/queries/` or `wiki/syntheses/`
|
|
58
|
+
5. Update `wiki/index.md` if a new page was created
|
|
59
|
+
|
|
60
|
+
### LINT (triggered by wotw lint or periodic maintenance)
|
|
61
|
+
|
|
62
|
+
1. Scan all wiki pages for contradictions between pages
|
|
63
|
+
2. Identify orphan pages (no inbound links)
|
|
64
|
+
3. Identify stale pages (sources updated but wiki page not)
|
|
65
|
+
4. Identify missing cross-references
|
|
66
|
+
5. Fix what you can, flag what needs human review
|
|
67
|
+
6. Append findings to `wiki/log.md`
|
|
68
|
+
|
|
69
|
+
## Quality Standards
|
|
70
|
+
|
|
71
|
+
- Every page must have at least 3 sentences of substantive content
|
|
72
|
+
- Every page must link to at least one other wiki page
|
|
73
|
+
- Every concept page must cite at least one source
|
|
74
|
+
- No duplicate pages — if two pages cover the same topic, merge them
|
|
75
|
+
- Use consistent terminology — define terms on first use, link to entity/concept pages
|
|
76
|
+
- Confidence levels:
|
|
77
|
+
- `high` — multiple corroborating sources
|
|
78
|
+
- `medium` — single source
|
|
79
|
+
- `low` — inferred/synthesized
|
|
80
|
+
|
|
81
|
+
## Non-negotiable rules
|
|
82
|
+
|
|
83
|
+
1. NEVER write outside the `wiki/` directory.
|
|
84
|
+
2. NEVER modify files in `raw/`.
|
|
85
|
+
3. ALWAYS update `wiki/index.md` when you create or rename a page.
|
|
86
|
+
4. ALWAYS append an entry to `wiki/log.md` describing the operation.
|
|
87
|
+
5. NEVER delete a page without explicit instruction.
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Getting Started
|
|
3
|
+
category: concept
|
|
4
|
+
created: __WOTW_UPDATED_ISO__
|
|
5
|
+
updated: __WOTW_UPDATED_ISO__
|
|
6
|
+
sources: []
|
|
7
|
+
related: []
|
|
8
|
+
tags:
|
|
9
|
+
- onboarding
|
|
10
|
+
- guide
|
|
11
|
+
confidence: high
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Getting Started with Watcher on the Wall
|
|
15
|
+
|
|
16
|
+
Welcome! This page will help you start building your knowledge base.
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
1. **Drop files into `raw/`** — articles, papers, notes, PDFs, code, anything.
|
|
21
|
+
2. **Run `wotw start`** — the Watcher begins watching `raw/` for changes.
|
|
22
|
+
3. **Watch your wiki grow** — the Watcher automatically ingests files, extracts concepts, and creates interlinked pages.
|
|
23
|
+
|
|
24
|
+
## How It Works
|
|
25
|
+
|
|
26
|
+
The Watcher monitors your `raw/` directory for new and changed files. When it
|
|
27
|
+
detects a change, it:
|
|
28
|
+
|
|
29
|
+
1. Reads the source file(s)
|
|
30
|
+
2. Sends them to an LLM for analysis
|
|
31
|
+
3. Creates or updates wiki pages in the appropriate category
|
|
32
|
+
4. Repairs cross-references between pages
|
|
33
|
+
5. Rebuilds the search index
|
|
34
|
+
6. Commits changes to git
|
|
35
|
+
|
|
36
|
+
Every action is recorded in an append-only **provenance chain** so you can
|
|
37
|
+
always trace where information came from.
|
|
38
|
+
|
|
39
|
+
## Wiki Structure
|
|
40
|
+
|
|
41
|
+
Your wiki is organized into six categories:
|
|
42
|
+
|
|
43
|
+
| Category | Directory | What goes here |
|
|
44
|
+
| ----------- | ------------------- | --------------------------------------- |
|
|
45
|
+
| Concepts | `wiki/concepts/` | Ideas, frameworks, theories, patterns |
|
|
46
|
+
| Entities | `wiki/entities/` | People, organizations, products, tools |
|
|
47
|
+
| Sources | `wiki/sources/` | Summaries of ingested raw files |
|
|
48
|
+
| Comparisons | `wiki/comparisons/` | Side-by-side analyses of related topics |
|
|
49
|
+
| Syntheses | `wiki/syntheses/` | Cross-cutting themes and insights |
|
|
50
|
+
| Queries | `wiki/queries/` | Answers to questions you've asked |
|
|
51
|
+
|
|
52
|
+
## Useful Commands
|
|
53
|
+
|
|
54
|
+
| Command | Description |
|
|
55
|
+
| ----------------------- | ----------------------------------------------- |
|
|
56
|
+
| `wotw start` | Start the daemon (watches `raw/` for changes) |
|
|
57
|
+
| `wotw stop` | Stop the daemon |
|
|
58
|
+
| `wotw status` | Check daemon status, page counts, health |
|
|
59
|
+
| `wotw query "question"` | Ask a question (uses the running daemon) |
|
|
60
|
+
| `wotw search <terms>` | Offline full-text search (no daemon needed) |
|
|
61
|
+
| `wotw lint` | Check wiki health and find issues |
|
|
62
|
+
| `wotw lint --fix` | Auto-heal common issues |
|
|
63
|
+
| `wotw stale` | Find pages that haven't been confirmed recently |
|
|
64
|
+
| `wotw candidates` | List pages awaiting approval |
|
|
65
|
+
| `wotw approve <file>` | Approve a candidate page into the wiki |
|
|
66
|
+
| `wotw reject <file>` | Reject a candidate with optional feedback |
|
|
67
|
+
| `wotw audit` | View the provenance chain |
|
|
68
|
+
| `wotw logs` | Tail the daemon log |
|
|
69
|
+
|
|
70
|
+
## Tips
|
|
71
|
+
|
|
72
|
+
- **Obsidian users**: This wiki is designed to work beautifully with
|
|
73
|
+
[Obsidian](https://obsidian.md). Cross-references use `[[wikilinks]]` and
|
|
74
|
+
the graph view shows how concepts connect.
|
|
75
|
+
- **Search**: Use `wotw search` for quick offline lookups. Use `wotw query`
|
|
76
|
+
for deeper, LLM-powered answers.
|
|
77
|
+
- **Provenance**: Every page has a footer showing its sources. Click through
|
|
78
|
+
to see exactly where information came from.
|
|
79
|
+
- **Health**: Run `wotw lint` periodically to find stale pages, broken links,
|
|
80
|
+
and potential duplicates. Use `--fix` to auto-heal.
|
|
81
|
+
|
|
82
|
+
## Next Steps
|
|
83
|
+
|
|
84
|
+
1. Drop a few files into `raw/` and run `wotw start`
|
|
85
|
+
2. Browse the generated pages in `wiki/`
|
|
86
|
+
3. Try `wotw search` or `wotw query` to explore your knowledge
|
|
87
|
+
4. Check `wotw status` for a health overview
|
|
88
|
+
|
|
89
|
+
Happy knowledge building!
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Index
|
|
3
|
+
updated: __WOTW_UPDATED_ISO__
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Wiki Index
|
|
7
|
+
|
|
8
|
+
Welcome to your knowledge base. This index is automatically maintained by
|
|
9
|
+
[watcher-on-the-wall](https://github.com/3030-Labs/watcher-on-the-wall).
|
|
10
|
+
|
|
11
|
+
## Getting Started
|
|
12
|
+
|
|
13
|
+
Drop source files (articles, papers, notes, code) into the `raw/` folder.
|
|
14
|
+
The Watcher will automatically ingest them, extract key concepts, and build
|
|
15
|
+
interlinked wiki pages here.
|
|
16
|
+
|
|
17
|
+
## Categories
|
|
18
|
+
|
|
19
|
+
- **[[concepts]]** — Ideas, frameworks, theories
|
|
20
|
+
- **[[entities]]** — People, organizations, products, tools
|
|
21
|
+
- **[[sources]]** — Summaries of ingested source material
|
|
22
|
+
- **[[comparisons]]** — Side-by-side analyses
|
|
23
|
+
- **[[syntheses]]** — Cross-cutting themes and insights
|
|
24
|
+
- **[[queries]]** — Answers to questions asked of the wiki
|
|
25
|
+
|
|
26
|
+
## Recent Activity
|
|
27
|
+
|
|
28
|
+
<!-- wotw:index:start -->
|
|
29
|
+
|
|
30
|
+
_No pages yet. Drop files into raw/ to get started._
|
|
31
|
+
|
|
32
|
+
<!-- wotw:index:end -->
|