Skip to content

docs(tui): align frontend protocol references - #10246

Merged
lawrencecchen merged 2 commits into
mainfrom
fix-tui-frontend-protocol-docs
Sep 1, 2026
Merged

lawrencecchen merged 2 commits into
mainfrom
fix-tui-frontend-protocol-docs

Conversation

@lawrencecchen

@lawrencecchen lawrencecchen commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • update English and Japanese frontend README protocol claims to v12
  • add a contract test that derives the version from the web client and raw protocol guide
  • run the contract in the TUI spec workflow

Verification

  • commit a0ec52cfd2 adds the failing contract test (red)
  • commit a4a0767325 updates docs and workflow wiring (green)
  • python3 cmux-tui/scripts/test_frontend_docs.py -v
  • python3 -m py_compile cmux-tui/scripts/test_frontend_docs.py
  • PyYAML workflow contract and actionlint
  • TUI inventory, SDK schema, resource boundary, and codegen checks

No build, package publication, workflow dispatch, or merge was performed. This PR is independent of #10241 and #10242.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.


Summary by cubic

Aligns frontend README protocol references to v12 and adds a contract test so docs can't drift from the supported WebSocket protocol. READMEs previously could claim an outdated protocol version with nothing enforcing it; now the spec workflow fails when they mismatch.

  • Updates frontends/README.md, frontends/README.ja.md, and frontends/web/README.ja.md to reference protocol v12.
  • Adds cmux-tui/scripts/test_frontend_docs.py to assert that the web client's SUPPORTED_PROTOCOL, the protocol guide heading, and README claims all match.
  • Runs the new test in cmux-tui-spec.yml so version drift fails the workflow.
  • On protocol bumps, update frontends/web/src/lib/protocol.ts and docs/protocol.md first, then fix README references to the new version.

Written for commit e13626d. Summary will update on new commits.

Review in cubic

@coderabbitai

coderabbitai Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 4 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: 26abbbf6-faf9-4f12-9820-0ad783dc7272

📥 Commits

Reviewing files that changed from the base of the PR and between 56457e4 and e13626d.

📒 Files selected for processing (5)
  • .github/workflows/cmux-tui-spec.yml
  • cmux-tui/frontends/README.ja.md
  • cmux-tui/frontends/README.md
  • cmux-tui/frontends/web/README.ja.md
  • cmux-tui/scripts/test_frontend_docs.py

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.

@vercel

vercel Bot commented Sep 1, 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 2, 2026 3:34am UTC
cmux41 Ready Ready Preview Sep 2, 2026 3:34am UTC

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

@lawrencecchen
lawrencecchen force-pushed the fix-tui-frontend-protocol-docs branch from d3717a2 to e13626d Compare September 1, 2026 19:59
@lawrencecchen
lawrencecchen merged commit 6044a8b into main Sep 1, 2026
38 of 40 checks passed
rustybret pushed a commit to rustybret/bmux that referenced this pull request Sep 1, 2026
6044a8b docs(tui): align frontend protocol references (manaflow-ai#10246)
56457e4 perf(cmux-tui): avoid cloning projection specs per frame (manaflow-ai#11487)
9503718 ci: guard focused filters that match only ignored tests

This branch was successfully deployed

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