You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
User feedback: "Readme top demo of gitlab pages should be there, plus
simple rule of contribution, all docs are out of sync review every
thing test with actual data". This PR addresses all four asks.
README.md:
- Hoist the live demo link to the VERY top of the file, above the
badges. Presented as a big `## 👉` header so it's impossible to
miss. Demo URL: https://pratiyush.github.io/llm-wiki/
- Explain what the demo shows (heatmap, tool charts, token usage,
model info cards, vs-comparisons, project topics) so new visitors
know what to expect before clicking
- Update stale badges:
* version v0.4.0 → v0.9.0
* tests 95 passing → 420 passing
- New one-line "Contributing in one line:" paragraph immediately
after the install snippet, linking to CONTRIBUTING.md with the
TL;DR rules inline
CONTRIBUTING.md:
- New "TL;DR rules of contribution" section at the top with 7
numbered rules (one concern per PR, commit prefixes, no real
session data, no new runtime deps, tests must pass, CHANGELOG
entry, open issue for large work). Hits the user's "simple
rule of contribution" ask.
- Prominent link to the live demo up top so new contributors can
explore the product before reading the contribution rules
- Remove stale pygments references from the dev setup list
(superseded by highlight.js + CDN in #73)
- Fix the PR title format section: the repo uses conventional
commits (feat: / fix: / docs: / chore: / test:), not `add:`
which was documented here. Aligned with what git log actually
shows.
docs/getting-started.md:
- Update step 1 of the setup description to drop pygments and
explain that highlight.js runs in the browser via CDN
docs/architecture.md:
- Update L2 Site section to describe the v0.9 page surface:
heatmap, tool charts, token usage stats, models/, vs/,
changelog.html, AI exports
- Drop pygments from the runtime deps list in both the L2 description
and the Design principles section (item #1)
llmwiki/__init__.py + pyproject.toml:
- __version__ and pyproject version bumped 0.4.0 → 0.9.0 to match
the shipped feature set (#55, #56, #58, #60, #63, #64, #65, #66,
#72, #73, #74, #75, #76, #77, #78, #79, #80, #81 + project topics
all merged on master between v0.4 and now)
tests/test_v04.py:
- Relax the hardcoded version assertion so every release bump
doesn't break the v0.4 test module. New behavior: accept any
0.x.y pre-1.0 release with minor ≥ 4 (since the tests themselves
were introduced in v0.4)
- Replace `test_pyproject_version_matches` naive substring check
with an equality check against `__version__` — catches the
real bug (pyproject and package drifting apart) without being
tied to a specific number
420 tests still passing after the docs sync + version bump.
Verified the live build shows all 6 nav links (Home / Projects /
Sessions / Models / Compare / Changelog), the llm-wiki card shows
topic chips (`python, wiki, karpathy, claude-code, +3 more`), and
`llmwiki --version` prints `llmwiki 0.9.0`.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-8Lines changed: 28 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,11 @@
2
2
3
3
Thanks for wanting to contribute. This project follows strict rules about commits, PRs, and privacy — please read this before opening a PR.
4
4
5
+
**Try the live demo first:**[pratiyush.github.io/llm-wiki](https://pratiyush.github.io/llm-wiki/). It's rebuilt on every `master` push from [`examples/demo-sessions/`](examples/demo-sessions) so you can see every feature working before touching code.
6
+
5
7
## Table of contents
6
8
9
+
-[TL;DR rules of contribution](#tldr-rules-of-contribution)
7
10
-[Code of conduct](#code-of-conduct)
8
11
-[Dev setup](#dev-setup)
9
12
-[Project structure](#project-structure)
@@ -13,6 +16,18 @@ Thanks for wanting to contribute. This project follows strict rules about commit
13
16
-[Testing](#testing)
14
17
-[Releases](#releases)
15
18
19
+
## TL;DR rules of contribution
20
+
21
+
1.**One concern per PR.** Don't mix a bug fix with a new feature.
22
+
2.**Commit prefixes:**`feat:` / `fix:` / `docs:` / `chore:` / `test:` — e.g. `feat(v0.7): tool-calling bar chart (#65)`.
23
+
3.**Never commit real session data.**`raw/sessions/` is gitignored. Fixtures must be synthetic or heavily redacted.
24
+
4.**No new runtime deps.** Stdlib + `markdown` only. Viewer loads highlight.js from a CDN — no server-side parser needed.
25
+
5.**Tests must pass.** Run `python3 -m pytest tests/ -q` before pushing. CI runs on Python 3.9 + 3.12.
26
+
6.**Add a CHANGELOG entry** under `## [Unreleased]` for every user-visible change.
27
+
7.**Open an issue first** for anything bigger than a one-file fix. Keeps scope aligned.
28
+
29
+
That's it. If you follow those seven rules your PR is 90% of the way through review.
30
+
16
31
## Code of conduct
17
32
18
33
Be kind. Respect privacy. Prefer plain English to jargon. No scope creep.
@@ -22,19 +37,18 @@ Be kind. Respect privacy. Prefer plain English to jargon. No scope creep.
No other runtime deps. That's a hard rule. Syntax highlighting runs in the browser via [highlight.js](https://highlightjs.org/) loaded from a CDN, so the build pipeline stays stdlib-only.
38
52
39
53
## Project structure
40
54
@@ -73,11 +87,17 @@ Adapted from the parent [Open Source Project Framework](docs/framework.md):
73
87
74
88
### PR title format
75
89
76
-
-`add: <feature>` — new functionality
77
-
-`fix: <what>` — bug fix
90
+
Use conventional-commit-style prefixes (matches what's in `git log` on
91
+
this repo):
92
+
93
+
-`feat: <feature>` or `feat(v0.X): <feature>` — new functionality
94
+
-`fix: <what>` or `fix(v0.X): <what>` — bug fix
78
95
-`docs: <what>` — docs only
79
-
-`chore: <what>` — refactor, dep bump, CI
80
-
-`test: <what>` — tests only
96
+
-`chore: <what>` — refactor, dep bump, CI, version bumps
97
+
-`test: <what>` or `test+docs: <what>` — tests only / tests + docs
98
+
99
+
Include the issue number in the PR title or body when the PR closes
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,14 @@
3
3
> **LLM-powered knowledge base from your Claude Code, Codex CLI, Cursor, Gemini CLI, and Obsidian sessions.**
4
4
> Built on [Andrej Karpathy's LLM Wiki pattern](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f).
5
5
6
+
## 👉 Live demo: **[pratiyush.github.io/llm-wiki](https://pratiyush.github.io/llm-wiki/)**
7
+
8
+
Rebuilt on every `master` push from the synthetic sessions in [`examples/demo-sessions/`](examples/demo-sessions). No personal data. Shows every feature of the real tool (activity heatmap, tool charts, token usage, model info cards, vs-comparisons, project topics) running against safe reference data.
[](https://claude.com/claude-code)
11
15
[](https://github.com/openai/codex)
12
16
@@ -21,7 +25,7 @@ Every Claude Code, Codex CLI, and Cursor session writes a full transcript to dis
21
25
./build.sh && ./serve.sh # build + serve at http://127.0.0.1:8765
22
26
```
23
27
24
-
> **Live demo:**https://pratiyush.github.io/llm-wiki/ — built from the dummy sessions in [`examples/demo-sessions/`](examples/demo-sessions) by [`.github/workflows/pages.yml`](.github/workflows/pages.yml). No personal data.
28
+
**Contributing in one line:**read [`CONTRIBUTING.md`](CONTRIBUTING.md), keep PRs focused (one concern each), use `feat:` / `fix:` / `docs:` / `chore:` / `test:` commit prefixes, never commit real session data (`raw/` is gitignored), no new runtime deps. CI must be green to merge.
Copy file name to clipboardExpand all lines: docs/architecture.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,17 +87,23 @@ llmwiki does NOT write to `wiki/` directly. The agent does, via slash commands (
87
87
88
88
Owner: `llmwiki/build.py`
89
89
90
-
Converts every file under `raw/sessions/` (and any hand-authored files under `wiki/`) into static HTML. Uses `python-markdown`+ `pygments` (optional, for syntax highlighting). Writes to `site/`.
90
+
Converts every file under `raw/sessions/` (and any hand-authored files under `wiki/`) into static HTML. Uses `python-markdown`(the only runtime dep) — syntax highlighting runs in the browser via highlight.js loaded from a pinned jsdelivr CDN (v0.5, #73), so the build pipeline itself stays stdlib-only. Writes to `site/`.
91
91
92
-
Pages rendered:
92
+
Pages rendered (v0.9 surface):
93
93
94
-
-`site/index.html` — home with hero + synthesis + project cards
95
-
-`site/projects/index.html` — project grid
96
-
-`site/projects/<project>.html` — per-project session list
94
+
-`site/index.html` — home with hero + 365-day activity heatmap + token-usage stat grid + recently-updated card + project grid with topic chips
95
+
-`site/projects/index.html` — project grid with freshness badges
96
+
-`site/projects/<project>.html` — per-project page with topics strip, 365-day heatmap (scoped), tool-calling bar chart, token timeline, main sessions + sub-agents
97
97
-`site/sessions/index.html` — sortable sessions table with filter bar
1.**Stdlib first.** Runtime dep: `markdown`only. Nothing else. Syntax highlighting runs client-side via a CDN-loaded highlight.js (v0.5, #73) so the build stays deterministic and offline-capable.
178
184
2.**Privacy by default.** Redact everything sensitive before it hits disk.
179
185
3.**Idempotent everything.** Re-running any command is safe and cheap.
180
186
4.**Localhost only.** No network, no telemetry, no cloud. The user controls if/when to publish.
Copy file name to clipboardExpand all lines: docs/getting-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ setup.bat
30
30
31
31
`setup.sh` / `setup.bat` does the following, idempotently:
32
32
33
-
1. Installs `markdown` (required) and `pygments` (optional, syntax highlighting) via `pip install --user`
33
+
1. Installs `markdown` (the only runtime dep) via `pip install --user`. Syntax highlighting runs in the browser via highlight.js loaded from a CDN, so the build stays stdlib-only.
34
34
2. Scaffolds `raw/`, `wiki/`, `site/` directories
35
35
3. Runs `llmwiki adapters` to show which agents are detected
36
36
4. Does a dry-run of the first sync so you see what *would* be converted
0 commit comments