|
1 | 1 | # 04-knowledge |
2 | 2 |
|
3 | 3 | Durable reference knowledge, run as an **LLM Wiki** (Karpathy's pattern) with pages in the |
4 | | -**Open Knowledge Format (OKF)**. Things you'd rather not re-derive later live here as a knowledge |
5 | | -graph that compounds over time, instead of being re-discovered on every question. |
| 4 | +**Open Knowledge Format (OKF)**. Things you'd rather not re-derive later matter here: knowledge |
| 5 | +lives here as a graph that compounds over time, instead of being re-discovered on every question. |
6 | 6 |
|
7 | 7 | ## The three layers |
8 | 8 |
|
9 | 9 | | Layer | What it holds | Editable? | Anonymous? | |
10 | 10 | |---|---|---|---| |
11 | 11 | | `raw/` | Primary material you or agents find — web clips, PDFs, files, datasets. | Read-only | No — git-ignored | |
12 | | -| `WorkOSWiki/` | LLM-maintained OKF pages, organised into topic bundles, with `index.md` + `log.md`. | LLM-maintained | **Yes** | |
| 12 | +| `WorkOSWiki/` | LLM-maintained OKF pages, in topic bundles, with `index.md` + `log.md`. | LLM-maintained | **Yes** | |
13 | 13 | | `schema/` | The operating model, page format, and rules. | Rarely | Yes | |
14 | 14 |
|
15 | | -The rest of the tooling (agents, commands) reads [`schema/SCHEMA.md`](schema/SCHEMA.md) to know how |
16 | | -to operate the base. A short auto-loaded [`CLAUDE.md`](CLAUDE.md) points there. |
| 15 | +Tooling reads [`schema/SCHEMA.md`](schema/SCHEMA.md) to operate the base; a short auto-loaded |
| 16 | +[`CLAUDE.md`](CLAUDE.md) points there. The three operations are also exposed as commands: |
| 17 | +`/ingest`, `/query-knowledge`, and `/lint-knowledge`. |
17 | 18 |
|
18 | 19 | ## How it runs — three operations |
19 | 20 |
|
20 | 21 | - **Ingest** — a new source in `raw/` is summarised into `WorkOSWiki/sources/` and folded into the |
21 | 22 | relevant topic pages, updating the indexes and the log. |
22 | | -- **Query** — questions are answered from `WorkOSWiki/index.md` first, cited with `[[wikilinks]]`, and |
23 | | - good answers are saved back as pages so knowledge compounds. |
| 23 | +- **Query** — questions are answered from `WorkOSWiki/index.md` first, cited with `[[wikilinks]]`, |
| 24 | + and good answers are saved back as pages so knowledge compounds. |
24 | 25 | - **Lint** — a periodic health check for contradictions, orphans, stale claims, and missing pages. |
25 | 26 |
|
26 | 27 | See [`schema/SCHEMA.md`](schema/SCHEMA.md) for the exact procedures. |
27 | 28 |
|
28 | 29 | ## Open in Obsidian |
29 | 30 |
|
30 | | -Use `WorkOSWiki/` as the UI: **open `04-knowledge/WorkOSWiki/` as your Obsidian vault** (not `04-knowledge/`). |
31 | | -That keeps the private, git-ignored `raw/` layer out of Obsidian's index and gives a clean graph of |
32 | | -just the knowledge pages. `[[wikilinks]]`, `tags:`, and `related:` all work as Obsidian links; |
33 | | -dated source pages carry `aliases:` so their `[[id]]` links resolve. Obsidian's `.obsidian/` config |
34 | | -is git-ignored via `WorkOSWiki/.gitignore`. |
| 31 | +**Open `04-knowledge/WorkOSWiki/` as your Obsidian vault** (not `04-knowledge/`). That keeps |
| 32 | +the private, git-ignored `raw/` layer out of Obsidian's index and gives a clean graph of just the |
| 33 | +knowledge pages. The vault name in Obsidian is the folder name (`WorkOSWiki`). `[[wikilinks]]`, `tags:`, and |
| 34 | +`related:` all work as Obsidian links; dated source pages and bundle indexes carry `aliases:` so |
| 35 | +their links resolve. Obsidian's `.obsidian/` config is git-ignored via `WorkOSWiki/.gitignore`. |
35 | 36 |
|
36 | 37 | ## Anonymity |
37 | 38 |
|
38 | | -`WorkOSWiki/` notes are **anonymous references**. Any real name, company, client, email, or location |
39 | | -belongs in `01-context/`, never in `WorkOSWiki/`, `schema/`, or templates. `raw/` |
40 | | -may contain personal or copyrighted material, so it is git-ignored and never shared; wiki pages |
41 | | -*summarise and cite* raw material, they never reproduce it verbatim. |
| 39 | +`WorkOSWiki/` notes are **anonymous references**. Real names, companies, clients, emails, or |
| 40 | +locations belong outside the wiki, in the private context folder (in a Work OS, `01-context/`), |
| 41 | +never in `WorkOSWiki/`, `schema/`, or templates. `raw/` may contain personal or copyrighted material, so it is git-ignored and never |
| 42 | +shared; wiki pages *summarise and cite* raw material, they never reproduce it verbatim. |
42 | 43 |
|
43 | 44 | ## Not part of the wiki |
44 | 45 |
|
|
0 commit comments