Commit 7dc13bb
committed
docs(skill): fix 5 factual mistakes flagged in self-review
All five were verified against the real openkb code and live CLI
output before fixing. Net effect: an agent following the skill no
longer hallucinates commands or off-by-one page reads, and the
reference docs match what `openkb list` / `index.md` / summary
frontmatter actually contain.
1. SKILL.md no longer references a nonexistent `openkb where` —
uses `openkb status` everywhere (the rest of the skill already
did; line 67 was a stale fragment from an earlier iteration).
2. SKILL.md's `jq` long-doc-page instruction is now unambiguous:
`jq '.[N-1]' wiki/sources/<doc>.json` (N = 1-indexed PDF page
number). Previous "(page N, 0-indexed)" wording risked
systematic off-by-one in agent reads.
3. references/commands.md shows the real `openkb list` Type column:
`pageindex` (for `long_pdf` registry entries) and `short` (for
every other format), matching `_TYPE_DISPLAY_MAP` in cli.py. The
prior "long_pdf / md" example was the raw registry values, not
the displayed ones.
4. references/wiki-schema.md's index.md example now shows `(short)`
/ `(pageindex)` type tags (what the compile pipeline emits), not
the raw `(long_pdf)` / `(md)` placeholders.
5. references/wiki-schema.md's summary frontmatter `full_text:` is
no longer described as "short docs only" — long PDFs also have
the field, pointing at the `.json` paginated content.
The remaining `long_pdf` strings in the docs intentionally describe
the raw registry value in `.openkb/hashes.json`, contrasted with the
displayed `pageindex` — they're the correct framing now.1 parent 5827d07 commit 7dc13bb
3 files changed
Lines changed: 26 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
68 | | - | |
| 67 | + | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
32 | | - | |
33 | | - | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
34 | 40 | | |
35 | 41 | | |
36 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
49 | | - | |
50 | | - | |
| 49 | + | |
| 50 | + | |
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| |||
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
60 | 65 | | |
61 | 66 | | |
62 | 67 | | |
| |||
70 | 75 | | |
71 | 76 | | |
72 | 77 | | |
73 | | - | |
| 78 | + | |
74 | 79 | | |
75 | 80 | | |
76 | 81 | | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
77 | 87 | | |
78 | 88 | | |
79 | 89 | | |
| |||
0 commit comments