Skip to content

Commit cb280cf

Browse files
committed
docs(readme): dedupe LLM setup, slim Configuration (keep PageIndex Setup)
Provider/model + key setup is already covered in Getting Started > 'Set up your LLM'; Configuration > Settings repeated it. Trim Settings to the core config.yaml keys + a pointer to examples/configuration (entity_types, OAuth, LiteLLM tuning). PageIndex Setup (kept for referral) and AGENTS.md are unchanged. Claude-Session: https://claude.ai/code/session_018WiFnTo1YW9mtw47Fzir9K
1 parent f79a0b5 commit cb280cf

1 file changed

Lines changed: 2 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -289,33 +289,15 @@ openkb visualize # build + open output/visualize/graph.html
289289

290290
### Settings
291291

292-
OpenKB settings are initialized by `openkb init` and stored in `.openkb/config.yaml`:
292+
`openkb init` writes `.openkb/config.yaml`:
293293

294294
```yaml
295295
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
296296
language: en # Wiki output language
297297
pageindex_threshold: 20 # PDF pages threshold for PageIndex
298298
```
299299
300-
Model names use `provider/model` LiteLLM [format](https://docs.litellm.ai/docs/providers) (OpenAI models can omit the prefix):
301-
302-
| Provider | Model example |
303-
|---|---|
304-
| OpenAI | `gpt-5.4` |
305-
| Anthropic | `anthropic/claude-sonnet-4-6` |
306-
| Gemini | `gemini/gemini-3.1-pro-preview` |
307-
308-
<details>
309-
<summary><i>Advanced options (<code>entity_types</code>, OAuth):</i></summary>
310-
<br>
311-
312-
`entity_types` (optional): a YAML list overriding the entity-type vocabulary used for entity pages; omit it to use the default `person`, `organization`, `place`, `product`, `work`, `event`, `other`.
313-
314-
Subscription-based providers that authenticate via OAuth device flow (e.g. `chatgpt/*`, `github_copilot/*`) need no API key; OpenKB skips the missing-key warning for them.
315-
316-
</details>
317-
318-
For deeper LLM/LiteLLM tuning — timeouts for slow local runtimes (Ollama, LM Studio), `drop_params`, GitHub Copilot headers, install notes — see **[`examples/configuration/`](examples/configuration/)**.
300+
The full settings reference — `entity_types`, OAuth providers (`chatgpt/*`, `github_copilot/*`), and LiteLLM tuning (timeouts for slow local runtimes like Ollama / LM Studio, `drop_params`, GitHub Copilot headers, install notes) — is in **[`examples/configuration/`](examples/configuration/)**.
319301

320302
### PageIndex Setup
321303

0 commit comments

Comments
 (0)