hypomnema 1.0.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/.claude-plugin/plugin.json +11 -0
- package/LICENSE +21 -0
- package/README.ko.md +160 -0
- package/README.md +160 -0
- package/commands/.gitkeep +0 -0
- package/commands/crystallize.md +116 -0
- package/commands/doctor.md +66 -0
- package/commands/feedback.md +67 -0
- package/commands/graph.md +54 -0
- package/commands/ingest.md +85 -0
- package/commands/init.md +101 -0
- package/commands/lint.md +55 -0
- package/commands/query.md +55 -0
- package/commands/resume.md +48 -0
- package/commands/stats.md +39 -0
- package/commands/uninstall.md +52 -0
- package/commands/upgrade.md +63 -0
- package/commands/verify.md +60 -0
- package/docs/.gitkeep +0 -0
- package/docs/ARCHITECTURE.md +183 -0
- package/docs/CONTRIBUTING.md +115 -0
- package/docs/TEST-CASES.md +580 -0
- package/hooks/.gitkeep +0 -0
- package/hooks/hooks.json +109 -0
- package/hooks/hypo-auto-commit.mjs +36 -0
- package/hooks/hypo-auto-stage.mjs +30 -0
- package/hooks/hypo-compact-guard.mjs +71 -0
- package/hooks/hypo-cwd-change.mjs +91 -0
- package/hooks/hypo-file-watch.mjs +47 -0
- package/hooks/hypo-first-prompt.mjs +59 -0
- package/hooks/hypo-hot-rebuild.mjs +95 -0
- package/hooks/hypo-lookup.mjs +178 -0
- package/hooks/hypo-personal-check.mjs +195 -0
- package/hooks/hypo-session-start.mjs +141 -0
- package/hooks/hypo-shared.mjs +213 -0
- package/package.json +37 -0
- package/scripts/.gitkeep +0 -0
- package/scripts/bump-version.mjs +53 -0
- package/scripts/crystallize.mjs +153 -0
- package/scripts/doctor.mjs +361 -0
- package/scripts/feedback.mjs +130 -0
- package/scripts/graph.mjs +183 -0
- package/scripts/ingest.mjs +130 -0
- package/scripts/init.mjs +515 -0
- package/scripts/lib/frontmatter.mjs +11 -0
- package/scripts/lib/hypo-ignore.mjs +54 -0
- package/scripts/lib/hypo-root.mjs +53 -0
- package/scripts/lint.mjs +210 -0
- package/scripts/query.mjs +124 -0
- package/scripts/resume.mjs +115 -0
- package/scripts/stats.mjs +132 -0
- package/scripts/uninstall.mjs +188 -0
- package/scripts/upgrade.mjs +538 -0
- package/scripts/verify.mjs +172 -0
- package/skills/.gitkeep +0 -0
- package/skills/crystallize/SKILL.md +85 -0
- package/skills/graph/SKILL.md +54 -0
- package/skills/ingest/SKILL.md +83 -0
- package/skills/lint/SKILL.md +55 -0
- package/skills/query/SKILL.md +58 -0
- package/skills/verify/SKILL.md +92 -0
- package/templates/.gitkeep +0 -0
- package/templates/.hypoignore +18 -0
- package/templates/Home.md +34 -0
- package/templates/Overview.md +50 -0
- package/templates/SCHEMA.md +106 -0
- package/templates/hot.md +22 -0
- package/templates/hypo-automation.md +69 -0
- package/templates/hypo-config.md +41 -0
- package/templates/hypo-guide.md +146 -0
- package/templates/hypo-help.md +53 -0
- package/templates/index.md +44 -0
- package/templates/log.md +25 -0
- package/templates/pages/_index.md +61 -0
- package/templates/projects/_template/hot.md +28 -0
- package/templates/projects/_template/index.md +39 -0
- package/templates/projects/_template/prd.md +29 -0
- package/templates/projects/_template/session-state.md +9 -0
- package/templates/session-state.md +12 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Overview
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, overview]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Wiki Overview
|
|
9
|
+
|
|
10
|
+
> A high-level map of this knowledge base. For the full page catalog see [[index]].
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Knowledge Areas
|
|
15
|
+
|
|
16
|
+
<!-- Group your pages by domain/topic area -->
|
|
17
|
+
<!-- Add sections as your wiki grows -->
|
|
18
|
+
|
|
19
|
+
### Concepts
|
|
20
|
+
|
|
21
|
+
<!-- [[concepts/topic]] — brief description -->
|
|
22
|
+
|
|
23
|
+
### Playbooks
|
|
24
|
+
|
|
25
|
+
<!-- [[playbooks/topic]] — how to do X -->
|
|
26
|
+
|
|
27
|
+
### Learnings
|
|
28
|
+
|
|
29
|
+
<!-- [[learnings/topic]] — what was learned and when -->
|
|
30
|
+
|
|
31
|
+
### Tool Evaluations
|
|
32
|
+
|
|
33
|
+
<!-- [[tool-evaluations/tool-name]] — adopt / hold / reject -->
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Projects
|
|
38
|
+
|
|
39
|
+
<!-- Links to active and archived project indexes -->
|
|
40
|
+
|
|
41
|
+
| Project | Status | Last Session |
|
|
42
|
+
|---------|--------|-------------|
|
|
43
|
+
| <!-- [[projects/name/index\|name]] --> | active | YYYY-MM-DD |
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Sources
|
|
48
|
+
|
|
49
|
+
<!-- Key external sources ingested into this wiki -->
|
|
50
|
+
<!-- [[sources/slug]] — title (YYYY-MM-DD) -->
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Schema
|
|
3
|
+
type: schema
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
version: 1.0
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Wiki Schema
|
|
9
|
+
|
|
10
|
+
The type system and vocabulary standard for this wiki.
|
|
11
|
+
Read this before any wiki operation (ingest / query / lint).
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 1. Page Type Taxonomy
|
|
16
|
+
|
|
17
|
+
| type | location | description | mutability |
|
|
18
|
+
|------|----------|-------------|------------|
|
|
19
|
+
| `concept` | `pages/` | Principles, theories, design ideas | mutable |
|
|
20
|
+
| `source-summary` | `pages/` | Summary of a `sources/` raw document | semi-immutable |
|
|
21
|
+
| `entity` | `pages/people/`, `pages/orgs/` | People, organizations | mutable |
|
|
22
|
+
| `tool-eval` | `pages/tool-evaluations/` | Tool evaluations (adopt / reject) | mutable |
|
|
23
|
+
| `prompt-pattern` | `pages/prompt-patterns/` | Verified prompt patterns | mutable |
|
|
24
|
+
| `playbook` | `pages/playbooks/` | Repeatable how-to procedures | mutable |
|
|
25
|
+
| `learning` | `pages/learnings/` | Discoveries, gotchas, lessons learned | append-only |
|
|
26
|
+
| `tip` | `pages/tips/` | Practical environment/tool tips | mutable |
|
|
27
|
+
| `feedback` | `pages/feedback/` | AI behavior correction records | append-only |
|
|
28
|
+
| `reference` | `pages/` | Config snapshots, external system references | mutable |
|
|
29
|
+
| `synthesis` | `pages/syntheses/` | Cross-page synthesis (3+ pages analyzed) | mutable |
|
|
30
|
+
| `weekly-journal` | `journal/weekly/YYYY-Www.md` | Weekly session/ingest summary | append-only |
|
|
31
|
+
| `prd` | `projects/*/prd.md` | Project purpose, success criteria, constraints | mutable |
|
|
32
|
+
| `adr` | `projects/*/decisions/NNNN-*.md` | Architecture decision records | immutable |
|
|
33
|
+
| `session-log` | `projects/*/session-log/YYYY-MM.md` | Chronological session narrative (monthly) | append-only |
|
|
34
|
+
| `session-state` | `projects/*/session-state.md` | Next-session handoff — overwritten each close | overwrite |
|
|
35
|
+
| `project-index` | `projects/*/index.md` | Project overview + progress checklist | mutable |
|
|
36
|
+
| `open-questions` | `pages/open-questions.md` | Unresolved question queue | append+resolve |
|
|
37
|
+
| `schema` | `SCHEMA.md` (this file) | Type system + vocabulary standard | versioned |
|
|
38
|
+
| `log` | `log.md` | Append-only activity log (ingest, session, note entries) | append-only |
|
|
39
|
+
| `config` | `hypo-config.md` | Wiki root marker + user settings | mutable |
|
|
40
|
+
|
|
41
|
+
**Notes**:
|
|
42
|
+
- `append-only`: never delete/modify existing entries. Corrections go as new entries (`[supersedes: YYYY-MM-DD]`).
|
|
43
|
+
- `immutable`: deprecated/superseded markers allowed, content edits forbidden.
|
|
44
|
+
- `semi-immutable`: factual corrections OK; interpretation/synthesis goes in `pages/` as a new page.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 2. Memory Layer Files
|
|
49
|
+
|
|
50
|
+
Files responsible for session continuity — separate from the type taxonomy above.
|
|
51
|
+
|
|
52
|
+
| file | role | constraint |
|
|
53
|
+
|------|------|-----------|
|
|
54
|
+
| `hot.md` (root) | Active project pointer table + last session date | Pointers only. No session content. |
|
|
55
|
+
| `projects/<name>/hot.md` | Last session snapshot — "what was done" | 500-word cap. No next-tasks. Overwrite each close. |
|
|
56
|
+
| `projects/<name>/session-state.md` | Next-session handoff — "what to do next" | Overwrite each close. Read at session start. |
|
|
57
|
+
| `projects/<name>/session-log/YYYY-MM.md` | Append-only narrative timeline (monthly) | No edits to existing entries. |
|
|
58
|
+
| `pages/open-questions.md` | Cross-project unresolved question queue | Append + mark resolved. |
|
|
59
|
+
|
|
60
|
+
**Operations**:
|
|
61
|
+
- Session start: root `hot.md` → project `hot.md` → `session-state.md`
|
|
62
|
+
- Session close: update project `hot.md` (what was done) + `session-state.md` (what to do next) + root `hot.md`
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 3. Required Frontmatter Fields
|
|
67
|
+
|
|
68
|
+
```yaml
|
|
69
|
+
---
|
|
70
|
+
title: <human-readable title>
|
|
71
|
+
type: <type from taxonomy above>
|
|
72
|
+
updated: YYYY-MM-DD
|
|
73
|
+
tags: [tag1, tag2]
|
|
74
|
+
---
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Optional fields (add as needed):
|
|
78
|
+
|
|
79
|
+
```yaml
|
|
80
|
+
confidence: high | medium | low | speculative
|
|
81
|
+
evidence_strength: direct | inferred | hearsay
|
|
82
|
+
scope: always | project | session
|
|
83
|
+
source: <slug or URL>
|
|
84
|
+
verify_by: <question to re-check at next review>
|
|
85
|
+
verify_by_date: YYYY-MM-DD
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 4. Tag Vocabulary
|
|
91
|
+
|
|
92
|
+
Use lowercase, hyphenated tags. Keep the vocabulary small and consistent.
|
|
93
|
+
|
|
94
|
+
**Domain tags**: `ai`, `dev`, `ops`, `security`, `data`, `design`, `management`
|
|
95
|
+
**Status tags**: `draft`, `stable`, `deprecated`, `needs-review`
|
|
96
|
+
**Meta tags**: `wiki`, `index`, `operations`, `guide`, `schema`
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 5. Source-First Principle
|
|
101
|
+
|
|
102
|
+
Wiki compound value comes from **external source ingestion**, not self-reference.
|
|
103
|
+
|
|
104
|
+
- At least 1 new external source per week in `sources/`
|
|
105
|
+
- `source: session:*` only chains → drift risk (see `pages/learnings/`)
|
|
106
|
+
- Every `source-summary` must reference a file in `sources/`
|
package/templates/hot.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Hot Cache — Pointer
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, operations]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Hot Cache
|
|
9
|
+
|
|
10
|
+
> Read at session start → navigate to the relevant project session-state.md and hot.md.
|
|
11
|
+
> Update at session close: project session-state.md, project hot.md, and this file's "Active Projects" table.
|
|
12
|
+
|
|
13
|
+
## Active Projects
|
|
14
|
+
|
|
15
|
+
| Project | Last Session | Hot Cache |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
|
|
18
|
+
## Session Start Checklist
|
|
19
|
+
|
|
20
|
+
1. Check this file for the relevant project link
|
|
21
|
+
2. Read `projects/<name>/session-state.md` for next tasks if it exists
|
|
22
|
+
3. Read `projects/<name>/hot.md` for project background
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Automation
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, automation, hooks]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Wiki Automation
|
|
9
|
+
|
|
10
|
+
How Hypomnema's Claude Code hooks work together to automate context injection,
|
|
11
|
+
session continuity, and git sync.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Hook Overview
|
|
16
|
+
|
|
17
|
+
| Hook | Event | Purpose |
|
|
18
|
+
|------|-------|---------|
|
|
19
|
+
| `hypo-session-start.mjs` | Session start | Injects `hot.md` and `session-state.md` into context |
|
|
20
|
+
| `hypo-first-prompt.mjs` | First user prompt | Injects active project context on first message |
|
|
21
|
+
| `hypo-auto-stage.mjs` | File save | Auto-stages changed wiki files |
|
|
22
|
+
| `hypo-auto-commit.mjs` | Session stop | Commits and pushes staged wiki changes |
|
|
23
|
+
| `hypo-compact-guard.mjs` | Pre-compact | Blocks `/compact` if session-log entry is missing |
|
|
24
|
+
| `hypo-hot-rebuild.mjs` | Post-tool | Rebuilds `hot.md` from project hot caches |
|
|
25
|
+
| `hypo-personal-check.mjs` | Pre-tool | Validates config and blocks on lint errors |
|
|
26
|
+
|
|
27
|
+
All hooks run **locally** — no network requests.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Session Flow
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Session start
|
|
35
|
+
└─ hypo-session-start.mjs → reads hot.md + session-state.md → injects context
|
|
36
|
+
|
|
37
|
+
During session
|
|
38
|
+
└─ hypo-auto-stage.mjs → auto-stages .md edits in wiki dir
|
|
39
|
+
└─ hypo-hot-rebuild.mjs → refreshes hot.md after project hot.md changes
|
|
40
|
+
|
|
41
|
+
Session end
|
|
42
|
+
└─ /session-compact → writes session-log, session-state, ADRs
|
|
43
|
+
└─ hypo-auto-commit.mjs → git commit + push
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## `.hypoignore`
|
|
49
|
+
|
|
50
|
+
Files matching patterns in `.hypoignore` are excluded from hook reads and index lookups.
|
|
51
|
+
They remain on disk but are invisible to all Hypomnema tooling.
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
# Example .hypoignore
|
|
55
|
+
journal/
|
|
56
|
+
*private*
|
|
57
|
+
sources/*.pdf
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Edit `.hypoignore` in your wiki root to exclude additional files or directories from hook context.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Lint Gate
|
|
65
|
+
|
|
66
|
+
`hypo-personal-check.mjs` runs `lint.mjs` before destructive operations.
|
|
67
|
+
If **blocker** errors are found, the operation is blocked until errors are resolved.
|
|
68
|
+
|
|
69
|
+
Run `/hypo:lint` to check and fix issues.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Hypomnema Config
|
|
3
|
+
type: config
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
created: YYYY-MM-DD
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Hypomnema Config
|
|
9
|
+
|
|
10
|
+
This file marks the root of your Hypomnema wiki.
|
|
11
|
+
Hooks use it to locate the wiki root automatically — do not delete or move it.
|
|
12
|
+
|
|
13
|
+
## Settings
|
|
14
|
+
|
|
15
|
+
To override the wiki root path, set the `HYPO_DIR` environment variable
|
|
16
|
+
instead of editing this file.
|
|
17
|
+
|
|
18
|
+
To bypass the session-close gate (e.g. for trivial sessions):
|
|
19
|
+
```
|
|
20
|
+
HYPO_SKIP_GATE=1
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Layout
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
<hypo-root>/
|
|
27
|
+
├── hypo-config.md ← you are here (root marker)
|
|
28
|
+
├── index.md ← searchable page index
|
|
29
|
+
├── hot.md ← active-project pointer table
|
|
30
|
+
├── log.md ← chronological activity log
|
|
31
|
+
├── hypo-guide.md ← operations guide
|
|
32
|
+
├── SCHEMA.md ← type system reference
|
|
33
|
+
├── .hypoignore ← glob patterns excluded from hooks
|
|
34
|
+
├── pages/ ← permanent knowledge pages
|
|
35
|
+
├── projects/ ← project work artifacts
|
|
36
|
+
│ └── <name>/
|
|
37
|
+
│ ├── index.md ← project overview (working_dir: field)
|
|
38
|
+
│ ├── hot.md ← project-scoped session snapshot
|
|
39
|
+
│ └── session-log/ ← monthly logs (YYYY-MM.md)
|
|
40
|
+
└── sources/ ← raw ingested sources (read-only)
|
|
41
|
+
```
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Operations Guide
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, guide, operations]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Wiki Operations Guide
|
|
9
|
+
|
|
10
|
+
How to run this wiki. For the type system, see [[SCHEMA]].
|
|
11
|
+
|
|
12
|
+
> **Before any wiki task**: read `SCHEMA.md` → `hypo-guide.md` on the first wiki operation of a session. Reuse for subsequent operations. Re-read after `/compact`, context resume, or if unsure.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 1. Why This Wiki Exists
|
|
17
|
+
|
|
18
|
+
Standard RAG chunks sources as-is — contradictions, stale content and all.
|
|
19
|
+
This wiki is different: **an LLM reads each source, synthesizes it, and updates existing pages**.
|
|
20
|
+
Over time, new sources *update* pages more than they *create* them — that's when compound value starts.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 2. Directory Layout
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
<hypo-root>/
|
|
28
|
+
├── hypo-config.md ← root marker (do not delete)
|
|
29
|
+
├── index.md ← searchable page catalog
|
|
30
|
+
├── hot.md ← active-project pointer table
|
|
31
|
+
├── log.md ← append-only activity log
|
|
32
|
+
├── SCHEMA.md ← type system reference
|
|
33
|
+
├── hypo-guide.md ← this file
|
|
34
|
+
├── .hypoignore ← privacy/exclusion patterns
|
|
35
|
+
├── pages/ ← permanent knowledge pages (subdirs added on demand)
|
|
36
|
+
│ ├── learnings/ (optional)
|
|
37
|
+
│ ├── playbooks/ (optional)
|
|
38
|
+
│ ├── feedback/ (optional)
|
|
39
|
+
│ └── open-questions.md (optional)
|
|
40
|
+
├── projects/ ← project work artifacts
|
|
41
|
+
│ └── <name>/
|
|
42
|
+
│ ├── index.md ← overview (working_dir: field)
|
|
43
|
+
│ ├── prd.md ← purpose / success criteria
|
|
44
|
+
│ ├── hot.md ← session snapshot
|
|
45
|
+
│ ├── session-state.md ← next-session handoff
|
|
46
|
+
│ ├── session-log/ ← monthly narrative logs
|
|
47
|
+
│ └── decisions/ ← ADRs (0001-*.md …)
|
|
48
|
+
└── sources/ ← raw ingested sources (never edit)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Rule**: never edit `sources/`. All knowledge creation goes in `pages/` and `projects/`.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 3. Core Operations
|
|
56
|
+
|
|
57
|
+
### Session Start
|
|
58
|
+
|
|
59
|
+
1. Read root `hot.md` → identify active project
|
|
60
|
+
2. If `cwd` matches `projects/<name>/index.md`'s `working_dir:` field → read `projects/<name>/session-state.md` first
|
|
61
|
+
3. Read `projects/<name>/hot.md` for background context
|
|
62
|
+
4. Offer: "Continuing [X] from last session — shall we pick up?"
|
|
63
|
+
|
|
64
|
+
### Session Close
|
|
65
|
+
|
|
66
|
+
Trigger: explicit close mention, `/compact` request, or context limit approaching.
|
|
67
|
+
|
|
68
|
+
1. Update `projects/<name>/session-state.md` (next tasks, overwrite)
|
|
69
|
+
2. Update `projects/<name>/hot.md` (what was done, ≤500 words, overwrite)
|
|
70
|
+
3. Append to `projects/<name>/session-log/YYYY-MM.md` (narrative entry, append-only)
|
|
71
|
+
4. Update root `hot.md` pointer table + date
|
|
72
|
+
|
|
73
|
+
Skip session close for: single bug fix, single-file edit, Q&A only.
|
|
74
|
+
|
|
75
|
+
### Ingest (external source → wiki)
|
|
76
|
+
|
|
77
|
+
1. Save raw source to `sources/<slug>.<ext>` (never edit after)
|
|
78
|
+
2. Read and synthesize
|
|
79
|
+
3. Update or create pages in `pages/` with frontmatter `source: <slug>`
|
|
80
|
+
4. Append to `index.md`
|
|
81
|
+
5. Append to `log.md`
|
|
82
|
+
|
|
83
|
+
### Query
|
|
84
|
+
|
|
85
|
+
1. Read `index.md` first
|
|
86
|
+
2. Cross-reference related pages
|
|
87
|
+
3. Synthesize answer — cite `[[page-slug]]` links
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 4. Page Creation Checklist
|
|
92
|
+
|
|
93
|
+
- [ ] Correct `type` from SCHEMA taxonomy
|
|
94
|
+
- [ ] `updated: YYYY-MM-DD` (today's date)
|
|
95
|
+
- [ ] Meaningful `tags` (see SCHEMA §4)
|
|
96
|
+
- [ ] Added to `index.md`
|
|
97
|
+
- [ ] Cross-links to related pages
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 5. Project Lifecycle
|
|
102
|
+
|
|
103
|
+
### Start a project
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
projects/<name>/
|
|
107
|
+
├── index.md (working_dir: /path/to/repo)
|
|
108
|
+
├── prd.md
|
|
109
|
+
└── session-state.md
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Add to root `hot.md` active projects table.
|
|
113
|
+
|
|
114
|
+
### Close a project
|
|
115
|
+
|
|
116
|
+
1. Write final `session-state.md` (mark as complete)
|
|
117
|
+
2. Update `projects/<name>/index.md` status
|
|
118
|
+
3. Remove from root `hot.md` active table (or mark archived)
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
## 6. ADR Format
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
projects/<name>/decisions/NNNN-short-title.md
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
```yaml
|
|
129
|
+
---
|
|
130
|
+
title: "NNNN: Short Title"
|
|
131
|
+
type: adr
|
|
132
|
+
status: accepted | deprecated | superseded
|
|
133
|
+
date: YYYY-MM-DD
|
|
134
|
+
superseded_by: NNNN # if applicable
|
|
135
|
+
---
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
ADRs are immutable once accepted. Mark deprecated/superseded but never edit content.
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## 7. Maintenance
|
|
143
|
+
|
|
144
|
+
- **Weekly**: check `pages/open-questions.md` for resolved items
|
|
145
|
+
- **Monthly**: review `log.md` for source-starved weeks (< 1 external source)
|
|
146
|
+
- **On schema change**: bump `SCHEMA.md` version, update this guide if layout changed
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Hypomnema — Command Reference
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [hypo, commands, reference]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Hypomnema Command Reference
|
|
9
|
+
|
|
10
|
+
Quick reference for all `/hypo:*` commands.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Setup & Maintenance
|
|
15
|
+
|
|
16
|
+
| Command | Description |
|
|
17
|
+
|---------|-------------|
|
|
18
|
+
| `/hypo:init` | Initialize a new wiki (first-time setup) |
|
|
19
|
+
| `/hypo:doctor` | Health check — verifies dirs, hooks, settings |
|
|
20
|
+
| `/hypo:upgrade` | Update hooks and settings to latest version |
|
|
21
|
+
| `/hypo:uninstall` | Remove hooks and deregister from settings.json |
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Daily Operations
|
|
26
|
+
|
|
27
|
+
| Command | Description |
|
|
28
|
+
|---------|-------------|
|
|
29
|
+
| `/hypo:resume` | Show next tasks from session-state.md |
|
|
30
|
+
| `/hypo:query <terms>` | Full-text search + synthesis across all pages |
|
|
31
|
+
| `/hypo:ingest <url/text>` | Add external knowledge to sources/ and synthesize |
|
|
32
|
+
| `/hypo:feedback <topic>` | Record AI behavior correction for a topic |
|
|
33
|
+
| `/hypo:stats` | Wiki health summary — page counts, ADRs, last activity |
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Knowledge Curation
|
|
38
|
+
|
|
39
|
+
| Command | Description |
|
|
40
|
+
|---------|-------------|
|
|
41
|
+
| `/hypo:crystallize` | Find synthesis candidates — tag clusters, unlinked pages, drafts |
|
|
42
|
+
| `/hypo:verify` | Review overdue verify_by deadlines |
|
|
43
|
+
| `/hypo:lint` | Validate frontmatter and `[[wikilinks]]` |
|
|
44
|
+
| `/hypo:graph` | Generate link graph (json / mermaid / dot) |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Tips
|
|
49
|
+
|
|
50
|
+
- **Session start**: `hot.md` → `session-state.md` → begin work
|
|
51
|
+
- **Session end**: run `/session-compact` (if available) or update session-state.md manually
|
|
52
|
+
- **Privacy**: edit `.hypoignore` to exclude sensitive paths from hooks
|
|
53
|
+
- **Verify schedule**: add `verify_by:` and `verify_by_date:` to pages you want to review periodically
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Wiki Index
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, index]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Wiki
|
|
9
|
+
|
|
10
|
+
> Master index of all knowledge pages.
|
|
11
|
+
> Format: `[[slug]] — one-line description`
|
|
12
|
+
> Keep entries alphabetical within each section.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Projects
|
|
17
|
+
|
|
18
|
+
<!-- Add project entries here as you create them -->
|
|
19
|
+
<!-- [[projects/my-project/index|my-project]] — brief description -->
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Pages
|
|
24
|
+
|
|
25
|
+
<!-- Knowledge pages, indexed by slug -->
|
|
26
|
+
|
|
27
|
+
### Learnings
|
|
28
|
+
|
|
29
|
+
<!-- [[learnings/topic]] — what was learned -->
|
|
30
|
+
|
|
31
|
+
### Playbooks
|
|
32
|
+
|
|
33
|
+
<!-- [[playbooks/topic]] — how to do X -->
|
|
34
|
+
|
|
35
|
+
### Tool Evaluations
|
|
36
|
+
|
|
37
|
+
<!-- [[tool-evaluations/tool-name]] — evaluation notes -->
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Sources
|
|
42
|
+
|
|
43
|
+
<!-- Ingested external sources -->
|
|
44
|
+
<!-- [[sources/slug]] — source title (YYYY-MM-DD) -->
|
package/templates/log.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Activity Log
|
|
3
|
+
type: log
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Activity Log
|
|
8
|
+
|
|
9
|
+
> Chronological record of all substantial wiki operations.
|
|
10
|
+
> Append a new `##` entry at session close.
|
|
11
|
+
|
|
12
|
+
## Entry types
|
|
13
|
+
|
|
14
|
+
- `session` — non-trivial multi-file work session
|
|
15
|
+
- `ingest` — new external source added to sources/
|
|
16
|
+
- `note` — standalone note (not a full session)
|
|
17
|
+
|
|
18
|
+
## Format
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
## [YYYY-MM-DD] session | <project-name>
|
|
22
|
+
## [YYYY-MM-DD] ingest | <source-title>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
---
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Pages Index
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [wiki, index, pages]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Pages
|
|
9
|
+
|
|
10
|
+
> All permanent knowledge pages, grouped by type.
|
|
11
|
+
> Format: `[[slug]] — one-line description`
|
|
12
|
+
> Keep entries alphabetical within each section.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Concepts
|
|
17
|
+
|
|
18
|
+
<!-- Principles, theories, design ideas -->
|
|
19
|
+
<!-- [[concepts/topic]] — description -->
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Learnings
|
|
24
|
+
|
|
25
|
+
<!-- Discoveries, gotchas, lessons learned (append-only) -->
|
|
26
|
+
<!-- [[learnings/topic]] — description -->
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Playbooks
|
|
31
|
+
|
|
32
|
+
<!-- Repeatable how-to procedures -->
|
|
33
|
+
<!-- [[playbooks/topic]] — how to do X -->
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Tool Evaluations
|
|
38
|
+
|
|
39
|
+
<!-- Tool adopt / hold / reject records -->
|
|
40
|
+
<!-- [[tool-evaluations/tool-name]] — evaluation summary -->
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Prompt Patterns
|
|
45
|
+
|
|
46
|
+
<!-- Verified prompt patterns for LLM interactions -->
|
|
47
|
+
<!-- [[prompt-patterns/pattern-name]] — description -->
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Syntheses
|
|
52
|
+
|
|
53
|
+
<!-- Cross-page synthesis (3+ pages analyzed) -->
|
|
54
|
+
<!-- [[syntheses/topic]] — synthesis summary -->
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Feedback
|
|
59
|
+
|
|
60
|
+
<!-- AI behavior correction records -->
|
|
61
|
+
<!-- [[feedback/topic]] — correction description -->
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: <project-name> — Hot Cache
|
|
3
|
+
type: reference
|
|
4
|
+
updated: YYYY-MM-DD
|
|
5
|
+
tags: [hot-cache, project]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# <project-name> — Hot Cache
|
|
9
|
+
|
|
10
|
+
> Project-scoped session snapshot. Updated at session close.
|
|
11
|
+
> Root `hot.md` holds the pointer table; this file holds the detail.
|
|
12
|
+
|
|
13
|
+
## Background
|
|
14
|
+
|
|
15
|
+
(1-3 sentences on what this project is and where it stands.)
|
|
16
|
+
|
|
17
|
+
## Current Focus
|
|
18
|
+
|
|
19
|
+
(What's being actively worked on right now.)
|
|
20
|
+
|
|
21
|
+
## Key Decisions
|
|
22
|
+
|
|
23
|
+
<!-- Brief pointers to important ADRs or design choices -->
|
|
24
|
+
<!-- [[decisions/0001-topic]] — decision summary -->
|
|
25
|
+
|
|
26
|
+
## Blockers / Open Questions
|
|
27
|
+
|
|
28
|
+
<!-- (none) -->
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: <project-name> — Index
|
|
3
|
+
type: project-index
|
|
4
|
+
status: active
|
|
5
|
+
started: YYYY-MM-DD
|
|
6
|
+
updated: YYYY-MM-DD
|
|
7
|
+
working_dir: ~/path/to/project
|
|
8
|
+
tags: [project]
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# <project-name>
|
|
12
|
+
|
|
13
|
+
> One-line description of the project.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Progress
|
|
18
|
+
|
|
19
|
+
- [ ] Phase 1 — Description
|
|
20
|
+
- [ ] Phase 2 — Description
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Key Files
|
|
25
|
+
|
|
26
|
+
| File | Purpose |
|
|
27
|
+
|------|---------|
|
|
28
|
+
| `prd.md` | Purpose and success criteria |
|
|
29
|
+
| `hot.md` | Session snapshot and background |
|
|
30
|
+
| `session-state.md` | Next-session handoff |
|
|
31
|
+
| `session-log/` | Monthly work narrative |
|
|
32
|
+
| `decisions/` | Architecture decision records |
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Links
|
|
37
|
+
|
|
38
|
+
- [[projects/<project-name>/prd|PRD]]
|
|
39
|
+
- [[projects/<project-name>/hot|Hot Cache]]
|