Skip to content

Commit 3b3f3e0

Browse files
committed
docs(readme): link to per-case usage examples
Add an Examples section pointing to examples/ (and examples/README.md), with a table of the per-feature cases. Claude-Session: https://claude.ai/code/session_018WiFnTo1YW9mtw47Fzir9K
1 parent 48269ec commit 3b3f3e0

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,26 @@ Create a `.env` file with your LLM API key:
113113
LLM_API_KEY=your_llm_api_key
114114
```
115115

116+
# 📚 Examples
117+
118+
Worked examples for each feature live in [`examples/`](examples/) — every case is a
119+
folder with a short walkthrough plus the **real artifact** OpenKB generated for it
120+
(a compiled wiki, a distilled skill, an HTML slide deck, an interactive graph).
121+
122+
| Example | Shows |
123+
| --- | --- |
124+
| [Configuration](examples/configuration/) | `init`, `config.yaml`, API keys, LiteLLM tuning (Ollama, LM Studio, Copilot) |
125+
| [Commands](examples/commands/) | the everyday loop: `add` · `query` · `remove` · `recompile` · `lint` · `list` · `status` |
126+
| [PageIndex Cloud](examples/pageindex-cloud/) | long documents: local vs. cloud indexing, and importing cloud-indexed docs |
127+
| [Chat TUI](examples/chat/) | the interactive REPL: persistent sessions + slash commands |
128+
| [Skill Factory](examples/skills/) | distill a redistributable agent skill from your wiki |
129+
| [Slides](examples/slides/) | generate a single-file HTML slide deck |
130+
| [Visualize](examples/visualize/) | render the wiki as an interactive knowledge graph |
131+
132+
The compiled wiki, skill, deck, and graph in those folders were **all** generated
133+
from a single paper — see [`examples/README.md`](examples/README.md) for the exact
134+
commands.
135+
116136
# 🧩 How OpenKB Works
117137

118138
### Architecture

0 commit comments

Comments
 (0)