Skip to content

docs(tui): align frontend protocol references on stack - #10260

Open
lawrencecchen wants to merge 2 commits into
feat-tui-package-runtime-floorfrom
rebase-tui-frontend-protocol-162c
Open

docs(tui): align frontend protocol references on stack#10260
lawrencecchen wants to merge 2 commits into
feat-tui-package-runtime-floorfrom
rebase-tui-frontend-protocol-162c

Conversation

@lawrencecchen

@lawrencecchen lawrencecchen commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Base and history

Verification

  • frontend docs contract
  • Python compile check
  • inventory, SDK schema, resource-boundary, and codegen checks
  • PyYAML workflow contract and actionlint

No merge, tag, package publication, or build was performed.


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 TUI frontend README protocol references to v12 and adds a CI test that prevents version drift. Previously READMEs cited v7/v10 with no check; now they cite v12 and the spec workflow fails if docs diverge from the supported wire API.

  • Adds cmux-tui/scripts/test_frontend_docs.py to assert that SUPPORTED_PROTOCOL in the web frontend, cmux-tui/docs/protocol.md, and all frontend READMEs reference the same protocol version.
  • Runs the new test in .github/workflows/cmux-tui-spec.yml.
  • No runtime or SDK changes; documentation and CI only.

Rollout

  • When bumping the wire protocol, update SUPPORTED_PROTOCOL, cmux-tui/docs/protocol.md, and README protocol lines; CI will fail if they are inconsistent.

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

Review in cubic

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 13ef7bba-bae0-4f6f-bff4-55aff8395698

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

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