Skip to content

docs(tui): refresh SDK inventory counts - #11766

Merged
lawrencecchen merged 2 commits into
mainfrom
docs-sdk-counts
Sep 3, 2026
Merged

lawrencecchen merged 2 commits into
mainfrom
docs-sdk-counts

Conversation

@lawrencecchen

@lawrencecchen lawrencecchen commented Sep 3, 2026 •

Copy link
Copy Markdown
Contributor

The protocol-12 SDK schema now contains 104 commands and 47 event shapes. Two documentation pages still reported the prior 101-command and 46-event inventory.

Update the SDK ergonomics report and Go raw SDK README to match the canonical generated schema. Evidence from cmux-tui/spec/sdk-schema.json: 104 commands, 47 events, including 46 emitted and one serialized-only event.

Validation:

  • git diff --check
  • Generated source count script matches 104 commands and 47 events

Docs-only change. No runtime or generated artifacts changed.


Summary by cubic

Updates the SDK inventory counts in the ergonomics report and Go raw README from 101 commands and 46 events to 104 and 47, matching the canonical protocol-12 schema, and adds a conformance test that fails if the docs drift from the generated schema.

  • The new test in test_runner.py reads sdk-schema.json and asserts the documented counts and matrix math stay in sync.
  • Docs-only change; no runtime or generated artifacts were touched.

Written for commit 6a544ff. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Updated SDK documentation to reflect coverage of 104 protocol commands and 47 event shapes.
    • Corrected command and event counts in ergonomics, conformance, and Go SDK documentation.

@vercel

vercel Bot commented Sep 3, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
cmux166 Ready Ready Preview Sep 3, 2026 4:17pm UTC
cmux41 Ready Ready Preview Sep 3, 2026 4:17pm UTC

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@coderabbitai

coderabbitai Bot commented Sep 3, 2026 •

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 6 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 8f069c18-40ef-443d-83eb-2a5dfa865039

📥 Commits

Reviewing files that changed from the base of the PR and between 638aa7d and 6a544ff.

📒 Files selected for processing (2)
  • cmux-tui/bindings/ERGONOMICS.md
  • cmux-tui/bindings/conformance/raw/test_runner.py

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: c64e0093-647c-4507-adc9-fa7bfd9cac5f

📥 Commits

Reviewing files that changed from the base of the PR and between 8fa163d and 638aa7d.

📒 Files selected for processing (2)
  • cmux-tui/bindings/ERGONOMICS.md
  • cmux-tui/bindings/go/raw/README.md

Included review availability: Your plan provides up to 10 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation updates protocol-12 coverage counts from 101 commands and 46 events to 104 commands and 47 events or event shapes across the TUI ergonomics and Go SDK documentation.

Changes

Protocol count documentation

Layer / File(s) Summary
Synchronize protocol counts
cmux-tui/bindings/ERGONOMICS.md, cmux-tui/bindings/go/raw/README.md
The documentation now reports 104 protocol-12 commands and 47 events or event shapes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 638aa

Documentation now reports 104 protocol-12 commands and 47 event shapes consistently in the SDK ergonomics and Go raw SDK pages. The counts are supported by generated coverage evidence, with no runtime or API changes.

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change: refreshing SDK inventory counts.
Description check ✅ Passed The description provides the change summary, rationale, validation commands, and scope. It does not include the template's Review Trigger or Checklist sections, but the missing Demo Video is not appli…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Cmux Swift Actor Isolation ✅ Passed PASS: The pull-request commit changes only two Markdown documentation files. The exact parent-to-HEAD diff contains no Swift paths or production Swift declarations. Therefore, it does not introduce or…
Cmux Swift Blocking Runtime ✅ Passed PASS: The pull-request diff changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. It changes protocol inventory counts only. The diff contains no…
Cmux Browser Automation Off-Main ✅ Passed PASS: The exact PR diff changes only cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. It updates documentation counts only. It does not change browser socket commands, execu…
Cmux Expensive Synchronous Load ✅ Passed PASS: The pull-request commit changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The patch updates protocol inventory counts only. It adds no …
Cmux Cache Substitution Correctness ✅ Passed PASS: The pull request changes only two Markdown documentation files. The exact parent-to-HEAD diff contains no Swift, TypeScript, or JavaScript changes and no persistence, history, undo, or snapshot …
Cmux No Hacky Sleeps ✅ Passed PASS: The parent-to-HEAD diff changes only two Markdown documentation files. The changes update command and event counts from 101/46 to 104/47. No TypeScript, JavaScript, shell, or build/runtime file …
Cmux Algorithmic Complexity ✅ Passed PASS: The parent-to-HEAD diff changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The diff only updates documented command and event counts. It…
Cmux Swift Concurrency ✅ Passed PASS. The HEAD diff changes only two Markdown documentation files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The diff contains no Swift paths and introduces no Swift …
Cmux Swift @Concurrent ✅ Passed PASS: The pull request changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The exact commit diff contains no Swift files and no changes to `@co…
Cmux Swift Package Boundaries ✅ Passed PASS: The pull request changes only two Markdown documentation files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The committed diff contains no Swift, package manifest…
Full details: Description check

Explanation

The description provides the change summary, rationale, validation commands, and scope. It does not include the template's Review Trigger or Checklist sections, but the missing Demo Video is not applicable to this docs-only change.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Full details: Cmux Swift Actor Isolation

Explanation

PASS: The pull-request commit changes only two Markdown documentation files. The exact parent-to-HEAD diff contains no Swift paths or production Swift declarations. Therefore, it does not introduce or worsen any Swift 6 actor-isolation issue covered by the rule.

Full details: Cmux Swift Blocking Runtime

Explanation

PASS: The pull-request diff changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. It changes protocol inventory counts only. The diff contains no Swift files and introduces no semaphore, wait, sleep, delayed dispatch, polling, main-queue sync, or manual lock. The Swift blocking-runtime failure condition does not apply.

Full details: Cmux Browser Automation Off-Main

Explanation

PASS: The exact PR diff changes only cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. It updates documentation counts only. It does not change browser socket commands, execution policy, worker routing, WebKit/AppKit access, or policy tests. The custom check is therefore inapplicable.

Full details: Cmux Expensive Synchronous Load

Explanation

PASS: The pull-request commit changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The patch updates protocol inventory counts only. It adds no Swift code, agent-history load, synchronous I/O, or interactive-path call site.

Full details: Cmux Cache Substitution Correctness

Explanation

PASS: The pull request changes only two Markdown documentation files. The exact parent-to-HEAD diff contains no Swift, TypeScript, or JavaScript changes and no persistence, history, undo, or snapshot code changes. The cache-substitution correctness check is therefore not applicable.

Full details: Cmux No Hacky Sleeps

Explanation

PASS: The parent-to-HEAD diff changes only two Markdown documentation files. The changes update command and event counts from 101/46 to 104/47. No TypeScript, JavaScript, shell, or build/runtime file changed, and no fixed sleep or timer was introduced.

Full details: Cmux Algorithmic Complexity

Explanation

PASS: The parent-to-HEAD diff changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The diff only updates documented command and event counts. It adds no Swift, TypeScript, JavaScript, shell, or runtime code, so it cannot introduce a failure covered by the algorithmic-complexity rule.

Full details: Cmux Swift Concurrency

Explanation

PASS. The HEAD diff changes only two Markdown documentation files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The diff contains no Swift paths and introduces no Swift concurrency patterns. Therefore, the custom check has no applicable failure condition.

Full details: Cmux Swift `@Concurrent`

Explanation

PASS: The pull request changes only two Markdown files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The exact commit diff contains no Swift files and no changes to @concurrent, nonisolated async, actor isolation, or async call sites. The Swift concurrency check is therefore inapplicable.

Full details: Cmux Swift Package Boundaries

Explanation

PASS: The pull request changes only two Markdown documentation files: cmux-tui/bindings/ERGONOMICS.md and cmux-tui/bindings/go/raw/README.md. The committed diff contains no Swift, package manifest, or app-target source changes. The Swift package-boundary check is therefore not applicable.

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-sdk-counts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@lawrencecchen
lawrencecchen force-pushed the docs-sdk-counts branch 3 times, most recently from 35ec423 to 150cb54 Compare September 3, 2026 02:54
@lawrencecchen
lawrencecchen merged commit d59055d into main Sep 3, 2026
28 of 30 checks passed
rustybret pushed a commit to rustybret/bmux that referenced this pull request Sep 3, 2026
3cce67c Vault: recency-first All Sessions view, session search, and checkpoints with fork (manaflow-ai#10215)
94f51fb Fix aggregate child memory pressure before compressor exhaustion (manaflow-ai#10773)
13006ef cloud: surface whether after() has waitUntil for deferred create work (manaflow-ai#11782)
75eee0e Cloud VMs: bake the TigerVNC desktop (dock, wallpaper, cua-driver, noVNC) into the devbox recipe and open it at the machine's private address (manaflow-ai#11776)
36b5536 Fix terminal text bleed during live window resize (manaflow-ai#11530)
44b42c1 Cloud VMs: machines usage decoder and refresh fixes, edge smoke diagnostics (manaflow-ai#11759)
f11be3a ci(tui): scope Valgrind test compilation (manaflow-ai#11750)
9184f4c coderouter: many Claude upstream accounts per team, routed with affinity and cooldown failover (manaflow-ai#11775)
d3b9cdd cloud: attach waits for the baked supervisor; edge probe span joins the create trace (manaflow-ai#11777)
c69e317 test: make the cmuxTests target compile again (main-actor call, CLI-only type) (manaflow-ai#11770)
8185825 fix(history): stop idle History menu graph rebuild loop (manaflow-ai#10661)
723958e Test bounded stale-port retirement after listener exit (manaflow-ai#11356)
367682e Fix native terminal Copy honoring Ghostty clipboard flavor (manaflow-ai#11515)
d59055d docs(tui): refresh SDK inventory counts (manaflow-ai#11766)
89e4701 cmux-tui: use JoinSet shutdown for simple drains (manaflow-ai#11745)

# Conflicts:
#	.github/workflows/cmux-tui.yml

This branch was successfully deployed

2 active deployments
Preview – cmux41 — 6a544ff2 Deployed Sep 3, 2026 by vercel[bot]
Preview – cmux166 — 6a544ff2 Deployed Sep 3, 2026 by vercel[bot]
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