Repository navigation
Conversation
…klist, ws extra Addresses the four verified items from the 2026-09-21 doc audit (DustinTrap#261): - mcpb/manifest.json: "license" said MIT while pyproject/LICENSE/README all say Apache-2.0. Corrected to Apache-2.0. - docs/analysis/*.md: added a one-line "point-in-time field report" banner to each of the four dated narratives, so a reader knows the paths/versions in them reflect the tree at write-time (e.g. the 2026-07-03 RM1PE report still cites drivers/pikvm.py for the GL driver, moved by DustinTrap#140). Files kept where they are; wheels/llms.txt reference the paths. - docs/CONTRIBUTING.md: added a Release checklist section with an explicit "refresh or delete RESUME.md" step. RESUME.md goes stale every release (asserts the previous rc as released) yet CLAUDE.md tells every session to read it first; there was no release section at all. - README.md: the VCS install example recommended kvm-pilot[totp,ws], but the ws extra is a declared no-op back-compat alias (websocket-client is now a base dependency). Dropped to kvm-pilot[totp]. Docs + manifest field only; no code paths touched. tests/test_docs_guards.py and tests/test_mcpb_bundle.py pass.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Comment |
|
Thank you for taking this on, and for the care in it — the setup.md claim you caught in #277 ("deliberately picks up no pre-release") was wrong, exactly as you said, and the out-of-scope notes in #276 were right too. An apology is owed: a maintainer pass over the open issues ran in parallel without first checking the PR queue, and its versions of the same fixes (#280 for #254; #283 for #261) were merged before yours were reviewed. That is on us, not on you. Where your work shows up:
I'm leaving these open for you to close, so the record stays yours. Hardware reports and any further doc audit are very welcome — next time the queue gets checked first. |
|
Thank you for the detailed write-up and for crediting #275, #276 and #277 by name in the 1.0.0 CHANGELOG - that is more than generous, and the record being kept is the part that mattered to me. Since #280 and #283 already cover the same ground and these three branches now conflict with main, I am closing them to keep your queue clean, as you suggested. Noted on /take before starting - I will claim issues first next time. Happy to pick up hardware reports or another doc audit whenever useful. |
What
The four verified items from the 2026-09-21 doc audit in #261, all one-session work. Docs + a single manifest field; no code paths touched.
mcpb/manifest.json—"license": "MIT"→"Apache-2.0".pyproject.toml(license = "Apache-2.0"), theLICENSEfile (Apache text) and the README all already say Apache-2.0; the bundle manifest was the odd one out.docs/analysis/*.md— added a one-line point-in-time field report banner to each of the four dated narratives, so readers know the paths/versions quoted inside reflect the tree at write-time (e.g. the2026-07-03RM1PE report still citesdrivers/pikvm.pyfor the GL driver, moved by Refactor: split GLKVMDriver into its own drivers/glkvm.py (separate from pikvm.py) #140). Files kept exactly where they are —wheels/andllms.txtreference these paths.docs/CONTRIBUTING.md— added a Release checklist section (there was no release section at all) with an explicit "refresh or deleteRESUME.md" step:RESUME.mdgoes stale every release yetCLAUDE.mdtells every session to read it first.README.md— the "latest unreleased tree" install example recommendedkvm-pilot[totp,ws], butwsis a declared no-op back-compat alias (websocket-clientis now a base dependency, seepyproject.toml). Dropped tokvm-pilot[totp].Deliberately out of scope
[...ws]occurrences I left for you to decide on, since docs: hygiene drive-bys — mcpb license field, analysis banners, RESUME.md release step, GL REST-block dedup #261 named only README:109:docs/CONTRIBUTING.md:11—pip install -e ".[dev,totp,ws]"(editable dev install)src/kvm_pilot/skill/references/setup.md:33— samekvm-pilot[totp,ws] @ git+…VCS formSay the word and I'll fold them into this PR.
--prededup ("collapse restatements to a one-liner + link") — that's a multi-file prose rewrite with real judgment calls, so I kept it out of a hygiene drive-by. Happy to take it as a follow-up.Verification
mcpb/manifest.jsonstill parses (json.loadsOK);licensenowApache-2.0.pytest tests/test_docs_guards.py tests/test_mcpb_bundle.py→ 40 passed._current_doc_files()treatsdocs/analysis/as historical (never command-line-guarded), so the banners don't trip the install-consistency guard; the canonicalpip install --pre kvm-pilotline in README is untouched.Disclosure: drafted with AI tooling under my review; each change above was checked against the actual files and the two relevant test modules run locally.