Skip to content

Commit 3d3e086

Browse files
chore: address PR #150 review — revert config defaults, strip BOM, unvendor web/
- config.yaml.example: restore gpt-5.4 / en (unintentional flip to local dev values openai/deepseek-v4-flash / zh) - openkb/cli.py, tests/test_api.py: remove stray UTF-8 BOM - web/: stop vendoring the built bundle; add web/ to .gitignore; README notes the Workbench UI requires `npm run build` (API-only otherwise) Refs: PR #150
1 parent 5c2c512 commit 3d3e086

8 files changed

Lines changed: 9 additions & 190 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ kbs/
1919
# Local only
2020
docs/
2121
.claude/
22+
23+
# Built Workbench web bundle (regenerate with `cd frontend && npm install && npm run build`)
24+
web/

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ pip install -e ".[api]"
140140
python -m openkb.api --host 127.0.0.1 --port 8000 # serves the API + Workbench at http://127.0.0.1:8000/
141141
```
142142

143+
> **No build, no UI.** If you skip `npm run build`, the `web/` bundle is absent and `openkb-api` serves only the REST API under `/api/v1` — visiting `/` returns a 404. The Workbench web UI appears only after you build `frontend/` at least once.
144+
143145
Open `http://127.0.0.1:8000/` in your browser. On first launch a **Connection Settings** dialog asks for the API base (leave blank for same-origin) and the bearer token. The Workbench then provides:
144146

145147
- **Overview** — index/concept/summary/report stat cards, clickable concept chips, recent documents, and last-compile/lint activity.

config.yaml.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
model: openai/deepseek-v4-flash # LLM model (any LiteLLM-supported provider)
2-
language: zh # Wiki output language
1+
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
2+
language: en # Wiki output language
33
pageindex_threshold: 20 # PDF pages threshold for PageIndex
44

55
# Optional: override the entity-type vocabulary used for entity pages.

openkb/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""OpenKB CLI — command-line interface for the knowledge base workflow."""
1+
"""OpenKB CLI — command-line interface for the knowledge base workflow."""
22
from __future__ import annotations
33

44
# Silence import-time warnings (e.g. pydub's missing-ffmpeg warning emitted

tests/test_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from __future__ import annotations
1+
from __future__ import annotations
22

33
import json
44
from typing import Any

web/assets/index-B95kof3N.js

Lines changed: 0 additions & 171 deletions
This file was deleted.

web/assets/index-I-GkV6Af.css

Lines changed: 0 additions & 1 deletion
This file was deleted.

web/index.html

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)