Skip to content

docs(readme): describe main's current state - #61

Merged
sushiHex merged 2 commits into
mainfrom
docs/readme-refresh
Nov 8, 2026
Merged

sushiHex merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@sushiHex

@sushiHex sushiHex commented Nov 8, 2026

Copy link
Copy Markdown
Owner

Problem

The README on main documents features that only main has: Windows paging detection, warm with num_ctx/strict_fit/partial fits, and the Kokoro worker. Its install commands, however, pin v0.3.1, the latest release, which has none of them. Some other parts were out of date or missing:

Change

README only:

  • Install: a note that the commands pin 0.3.1 while the page describes main, with how to run main. The install lines are unchanged, so chore(release): 0.4.0 #37's edits to them still apply cleanly.
  • Intro: a paragraph on paging detection and runtimes outside Ollama.
  • Readings: documents unmonitored_runtimes, and says to check list_claims() before acting on one.
  • Windows: the ProgramFiles workaround, linked to fix(gpu): give nvidia-smi ProgramFiles under a minimal Windows env #52.
  • Trends: says trends are sampled on vram_status calls, separately from the paging sampler.
  • Development: says runners outside Ollama are reported, not managed.

When 0.4.0 ships, #37 should drop the "ahead of the release" note, as long as everything it lists is in that release. The Kokoro worker (#55-#60) landed after the release branch was cut.

Validation

  • Docs only.
  • Checked each claim against vram_mcp/server.py and core.py: _runtime_note, TIGHT_MB, maybe_log_sample and the tool list.
  • python -m pytest -q: 835 passed, 1 skipped.

🤖 Generated with Claude Code

https://claude.ai/code/session_01V2ENBkHd7pik2TTJnhBHnh

- Say that the install commands pin 0.3.1 while the page describes main,
  and which features are unreleased.
- Lead with Windows paging detection and unmonitored-runtime reporting.
- Document vram_status.unmonitored_runtimes (#49).
- Add the ProgramFiles workaround for clients that start servers with a
  minimal environment (#52).
- Distinguish trend sampling from the Windows paging sampler.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01V2ENBkHd7pik2TTJnhBHnh
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-08T06:23:34.914612Z d8ecc16 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

- README: per-session server footprint and the default state directory;
  link the release notes, the releasing guide and AGENTS.md.
- Configuration: document VRAM_MCP_KOKORO_PROFILE.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01V2ENBkHd7pik2TTJnhBHnh
@sushiHex
sushiHex merged commit 5c88cc6 into main Nov 8, 2026
15 checks passed
@sushiHex
sushiHex deleted the docs/readme-refresh branch November 8, 2026 06:54
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.

1 participant