Skip to content

docs: hygiene drive-bys — mcpb license, analysis banners, release checklist, dedup (#261) - #283

Open
DustinTrap wants to merge 1 commit into
mainfrom
docs/261-hygiene
Open

DustinTrap wants to merge 1 commit into
mainfrom
docs/261-hygiene

Conversation

@DustinTrap

Copy link
Copy Markdown
Owner

Closes #261.

All five audit items, each re-verified against the tree first:

  • mcpb/manifest.json license MIT → Apache-2.0 (pyproject, LICENSE and README all say Apache-2.0).
  • docs/analysis/*.md: a one-paragraph point-in-time banner under each H1. The 2026-07-03 RM1PE report no longer presents drivers/pikvm.py as the current GL driver path (it moved to drivers/glkvm.py in Refactor: split GLKVMDriver into its own drivers/glkvm.py (separate from pikvm.py) #140) and loses the "unit-B, unit-B" paste artifact. Files stay in place — wheels and llms.txt reference the paths.
  • Release checklist added to docs/CONTRIBUTING.md (it had no release section): the four version-pin sites and the tests that guard them, CHANGELOG, GitHub Release → release.yml → PyPI, the manual Registry publish workflow, outside verification, refresh or delete RESUME.md, delete the branch.
  • GL "REST API ships disabled" dedup: troubleshooting.md is the canonical home; README, getting-started, firmware-update and glkvm-onboarding each collapse to a one-liner plus link. driver-features.md deliberately keeps its copy — that bullet list mirrors GLKVM_QUIRKS and is drift-guarded (Guards: drift-check the mcp/README tool table + docs/cli.md against the live surface (no generation) #232).
  • pip install --pre rationale dedup: troubleshooting.md "Which pip install line" is canonical; README, getting-started and first-run link it. The install commands themselves stay (the --pre docs guard still passes).
  • README VCS install line drops the no-op ws extra.

Docs guards, mcpb bundle tests and build_wiki.py --check pass; no code changed.

🤖 Generated with Claude Code

…cklist, GL REST/--pre dedup (#261)

- mcpb/manifest.json said "MIT"; the project is Apache-2.0 (pyproject,
  LICENSE, README).
- docs/analysis/*.md: one point-in-time banner each; the RM1PE report no
  longer presents drivers/pikvm.py as the GL driver path (moved in #140)
  and loses a "unit-B, unit-B" paste artifact. Files stay where they are
  (wheels/llms.txt reference the paths).
- docs/CONTRIBUTING.md gains a "Releasing" section (there was none):
  version-pin sites, CHANGELOG, GitHub Release -> release.yml -> PyPI,
  the manual registry publish, outside verification, and "refresh or
  delete RESUME.md" - CLAUDE.md tells every session to read it first
  and it went stale every release.
- The GL "REST API ships disabled / nginx-kvmd.conf / upgrades revert it"
  block was restated in README, getting-started, firmware-update and
  glkvm-onboarding; each is now a one-liner linking troubleshooting.md's
  canonical section. driver-features.md keeps its copy: that list mirrors
  GLKVM_QUIRKS and is drift-guarded.
- The pip --pre rationale was restated in README, getting-started and
  first-run; each now links troubleshooting.md's "Which pip install line".
- README's VCS install line drops the no-op `ws` extra.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Next included review available in 54 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 90 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Team
  • Run ID: be63ac17-9a3d-45c7-8c3c-c70b78b56b84
📥 Commits

Reviewing files that changed from the base of the PR and between 4aa9200 and d98db34.

📒 Files selected for processing: 12
  • CHANGELOG.md
  • README.md
  • docs/CONTRIBUTING.md
  • docs/analysis/2026-07-01-deep-review.md
  • docs/analysis/2026-07-03-rm1pe-firmware-and-encoder.md
  • docs/analysis/2026-07-08-e2e-leaner-cut.md
  • docs/analysis/2026-07-08-perf-a13-a14.md
  • docs/firmware-update.md
  • docs/first-run.md
  • docs/getting-started.md
  • docs/glkvm-onboarding.md
  • mcpb/manifest.json
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: hygiene drive-bys — mcpb license field, analysis banners, RESUME.md release step, GL REST-block dedup

1 participant