P3.5: Docs — README + AGENTS.md zellij notes (multiplexer Phase 3)#437
Merged
P3.5: Docs — README + AGENTS.md zellij notes (multiplexer Phase 3)#437
Conversation
Update README's Requirements section to mention zellij as the
alternative multiplexer, and add a Multiplexer subsection under
Execution model that explains:
- .cuekit.yaml multiplexer / multiplexer_strict fields
- zellij behavioural differences (attach form, dump-screen)
- Per-task backend dispatch (handles persisted across config flips)
Update AGENTS.md with a multiplexer pitfall row covering:
- tmux default, zellij opt-in via .cuekit.yaml
- Soft-fallback behavior with multiplexer_strict opt-out
- Zellij 0.43 quirks (no --pane-id targeting, synthetic pane id)
- Phase 3 implementation status; Phase 4 (team dashboard) tracked
in #416-#421 but not implemented yet
The dedicated zellij smoke guide (docs/guides/zellij-backend-smoke.md)
is deferred to a follow-up — Phase 4 will introduce additional
zellij-specific UX surfaces and the smoke guide should cover both
solo and team-dashboard modes together.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #415. Final Phase 3 issue. README gains a Multiplexer
subsection explaining the
.cuekit.yamlmultiplexer:field andzellij behavioural differences. AGENTS.md gets a pitfall row
covering the zellij 0.43 quirks (no
--pane-idtargeting,synthetic pane id) and Phase 3 status.
The dedicated
docs/guides/zellij-backend-smoke.mdis deferred towhen Phase 4 lands — the smoke recipe should cover both solo and
team-dashboard modes together rather than ship two iterations.
Test plan
Phase 3 status after this PR