Repository: github.com/baskar-commits/KNode

Knode

Product & repository design hub (HTML companion to README.md). Full static doc set: GitHub Pages hub (/KNode/ — not /KNode/docs/…). Markdown sources: docs/ on GitHub.

Audience	End users installing Knode; developers cloning the repo
Product	Windows desktop assistant — topic Q&A over your Kindle highlights with citations (Gemini RAG)
Data contract	Local corpus.jsonl (user-produced; not shipped in the repo)
Status	MVP — ship path via Inno Setup installer + GitHub Releases (see security doc)
Last updated	2026-04-09

---

Table of contents

---

1. Executive summary

Knode answers natural-language questions using your own Kindle reading: highlights ingested into corpus.jsonl, embedded with Google Gemini, retrieved by cosine similarity, then answered with citations in a WPF desktop UI (WebView2 for answer/sources).

The shipped loop is retrieval-augmented generation (RAG). Product language emphasizes grounded, citation-backed recall across books; richer agentic behavior remains roadmap.

Read alongside: the canonical narrative is KNODE-MVP-GUIDE.html §1–3. Architecture detail: KNODE-ARCHITECTURE.html.

---

2. Navigate this repository

Knode-only users need this hub (or the README) plus the install/first-run docs below. Developers may use subdirectory READMEs for the WebView spike and Python CLI.

If you want to…	Open (GitHub Pages HTML)
One doc — product intent, design, corpus pipeline	KNODE-MVP-GUIDE.html
Install and first run the Windows app	KNODE-INSTALL.html → KNODE-FIRST-RUN.html
Architecture (HTML), history, security / releases	KNODE-ARCHITECTURE.html · JOURNEY.md · SECURITY-AND-RELEASES.md
WebView capture (Kindle Notebook)	spike/webview-notebook/README.md
Python pipeline (parse_dump, Chroma, query_cli)	mvp/README.md

---

3. Install the Windows app

End users: prerequisites (.NET 8 Desktop Runtime x64, WebView2), SmartScreen note, and installer expectations — see KNODE-INSTALL.html.

Maintainers: Inno Setup Knode.iss, build-installer.ps1; trust and release process in SECURITY-AND-RELEASES.md.

4. First run

Corpus path, API key, build index, first Ask — KNODE-FIRST-RUN.html. Producing corpus.jsonl: KNODE-MVP-GUIDE.html §4.

---

5. Canonical documentation

Reading (static HTML on GitHub Pages — site root, no docs/ in the URL):

Topic	Pages URL
Hub	baskar-commits.github.io/KNode/
This design hub	DESIGN.html
Product, personas, corpus pipeline	KNODE-MVP-GUIDE.html
Install	KNODE-INSTALL.html
First run	KNODE-FIRST-RUN.html
Architecture	KNODE-ARCHITECTURE.html

Markdown only / repo paths on GitHub:

Topic	Document
Chronological decisions	JOURNEY.md
Keys, privacy, releases	SECURITY-AND-RELEASES.md
Legacy pointers	KINDLE-INGESTION-DECISIONS.md, ADR-0001-mvp-stack.md
Edit HTML sources	docs/*.md + python scripts/build_doc_html.py

---

6. Repository hygiene & license

• corpus.jsonl and generated mvp/data/* are gitignored; only mvp/data/README.md stub is tracked.
• Do not commit API keys; use ignored local settings or environment variables (see security doc).
• License: MIT.

7. Publishing this page (GitHub Pages)

Expected URLs once the site is live (project Pages from the /docs folder):

• https://baskar-commits.github.io/KNode/ — documentation hub
• https://baskar-commits.github.io/KNode/DESIGN.html — this page directly
• Regenerate KNODE-*.html from Markdown: python scripts/build_doc_html.py (see hub)

Turn Pages on (fix 404)

1. Open the repo on GitHub → Settings → Pages (left sidebar).
2. Under Build and deployment → Source, choose Deploy from a branch.
3. Branch: main → folder /docs → Save.
4. Wait 1–3 minutes; refresh. If a banner shows “Your site is live at …”, use that URL.
5. If nothing builds, open the Actions tab and check for a failed “pages build and deployment” workflow.

Private repository + free account

GitHub Pages does not publish from a private repository on the free plan (personal account). You need either a public repository for this project, or a GitHub Pro (or Team/Enterprise) subscription. A generic “There isn’t a GitHub Pages site here” / 404 often means Pages is off or the repo is private on Free.

Static HTML — no Mermaid or external scripts. Update “Last updated” and links when branching or renaming the repo.