Update docs/HANDOFF.md to current state - #5
Merged
Conversation
docs/HANDOFF.md was written before the rename and landed on main via PR #2, so it still pointed future readers at paths that no longer exist: `dotnet build MuGlyph.slnx`, `src/MuClient.Tui/MuGlyphApp.cs`, and the `tests/MuClient.*` test projects. Following it would have failed immediately. Updates every path and command to the SharpMUTerm names, and replaces the header block -- which described an unmerged branch and PR at the old repo -- with the current state: both PRs merged, work starts fresh off main. Test count corrected to the full 514 across five projects (it listed only Core and Tui). Verified every path the document names now resolves in the tree. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Walkthrough
ChangesHandoff documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
A handoff should describe the current state only -- the next session needs to know what is true now, not what changed to get here. Removes the rename/repo-move note, retitles "Key Files Touched This Session" to "Key Files" (the file->role map is orientation, not history), and rewrites the header block as plain current state: repository, where to branch from, test status. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
HarryCordewener
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/HANDOFF.md`:
- Line 117: In docs/HANDOFF.md, add one blank line immediately after the closing
fenced test-command block and before the following prose to satisfy Markdownlint
MD031.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9d21f2da-5583-4457-b6f8-3f6e951e6b6e
📒 Files selected for processing (1)
docs/HANDOFF.md
| dotnet run --project tests/MuClient.Tui.Tests </dev/null | ||
| dotnet run --project tests/SharpMUTerm.Core.Tests </dev/null | ||
| dotnet run --project tests/SharpMUTerm.Tui.Tests </dev/null | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a blank line after the fenced test commands.
The closing fence on Line 117 is immediately followed by prose on Line 118, triggering Markdownlint MD031. Insert one blank line after the fence.
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 117-117: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/HANDOFF.md` at line 117, In docs/HANDOFF.md, add one blank line
immediately after the closing fenced test-command block and before the following
prose to satisfy Markdownlint MD031.
Source: Linters/SAST tools
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/HANDOFF.md (1)
107-112: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument how to run all five test suites.
The commands shown execute only Core and Tui, while the next line says the primary signal includes Core, Graphics, Scripting, Web, and Tui. Add commands for the remaining three suites, or explicitly label these as a partial smoke-test subset and provide the full five-suite procedure.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/HANDOFF.md` around lines 107 - 112, Update the test-running instructions near the existing Core and Tui commands to document all five suites: Core, Graphics, Scripting, Web, and Tui, each with the same stdin-detaching behavior. Alternatively, clearly label the current commands as a partial smoke-test subset and add the complete five-suite procedure, keeping the stated build and warning-free expectations consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/HANDOFF.md`:
- Around line 107-112: Update the test-running instructions near the existing
Core and Tui commands to document all five suites: Core, Graphics, Scripting,
Web, and Tui, each with the same stdin-detaching behavior. Alternatively,
clearly label the current commands as a partial smoke-test subset and add the
complete five-suite procedure, keeping the stated build and warning-free
expectations consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7d93a654-1244-4719-b71e-775d4e6cc5b1
📒 Files selected for processing (1)
docs/HANDOFF.md
HarryCordewener
added a commit
that referenced
this pull request
Jul 31, 2026
"I am looking for the characters to have different numbers? Am I not communicating something right here? Like, I would expect Riko's next window to be #5 for instance. But perhaps I should attack this a different way. Let's assume we keep this way. Pane 1-2-3-4- etc under the same connection. Let's create a different mechanic to easily be able to switch characters then!" - and then, choosing between the two: "Let's take option B for cycling characters & panes separately." Global window numbering failed the first day it was used. With three characters sharing pane 1 as tabs, every character's row read Alt-1, because their windows happened to be numbered from one run; and nine digits do not stretch over everybody's windows - six across three characters already crowds them. Alt+1-9 now selects a window of the *active character*, numbered from 1 within that character. Alt-1 is your own window whoever you are, Alt-2 your first capture. An unowned window (the web view) is in every character's list, so it wears a different digit under each - which is exactly the set the rail draws window rows for, so the sidebar and the chord are one list read twice. Characters are reached by Alt+J and Alt+K, forward and back. Letters and not a third digit row because there is no third digit-bearing modifier this terminal delivers: read off a pty, kitty writes Alt+Shift+1 as CSI 49;4u and Ctrl+Shift+N as CSI 110;6u - kitty-keyboard-protocol sequences the parser does not decode and drops - while Alt+j and Alt+k are a plain ESC j / ESC k. The cycle walks only the characters already open, because SwitchToCharacter *creates* a session and a window for one that is not, and a cycle key that did that per press would dial through a configuration by accident. The sidebar follows. A character row carries Alt-J or Alt-K when it is one of the two neighbours and nothing otherwise - including the row you are on, whose marker already says so. It used to carry the chord of that character's own window, which under a scoped numbering is Alt-1 against everybody. The chord now leads each row instead of trailing it. "There is still way too much room after a window's name before it hits 'alt-1'" - that gap was the reserved pen and unread fields, which cannot be removed (a cell that costs only when it has something to say resizes the sidebar, and the sidebar's width comes out of the panes, which every server is told over NAWS). So the chord moved to the front, against the name it names, and the badges ended up at the right edge. Measured: the demo rail is 22 columns before and after, and the gap is 5 cells before and 0 after. The field is reserved per row *kind*, because with fewer than two characters open no character row can hold a cycle chord and reserving across both spent three cells on every character row of the commonest client there is. Alt where Alt is safer, measured rather than preferred: - Disconnect moves from Ctrl+D to Alt+D, so it and Alt+R read as one pair. Ctrl+D is released outright rather than kept as an alias - a second key for one action is either a secret or a duplicate row on every surface that lists chords - and releasing it hands a clean Ctrl chord back for macros. Nothing takes it: HandleMoveInput is gated on IsMovable (false here) and acts only on the arrows and X, and InputBarControl's Ctrl table has no D. Pinned by a test that presses it and checks the connection and the window count. - Ctrl+Tab is removed, and it was never real. A terminal writes 0x09 for it, which *is* Tab, so the parser reports ConsoleKey.Tab with no Control bit and the claim could never have matched - while Claimed is consulted first, so F4 told users a chord was taken that cannot arrive. The byte is in ControlBytes now, so Verdict says so. - Deliberately left on Ctrl: Ctrl+R (readline's history search), Ctrl+P, Ctrl+Q (safe here - TerminalRawMode clears IXON, so it is not XON), Ctrl+B, Ctrl+O, Ctrl+N/W/F and the command line's A/E/K/U/L. A sweep that moved everything would be as wrong as one that moved nothing. - Flagged, not fixed: Ctrl+N and Ctrl+O have no reverse, and Ctrl+W and Ctrl+B x are two chords for one action. Both are behaviour changes rather than modifier moves. Two fixes found on the way. BuildCharacterRefs passed `_active?.SessionKey == key` as *Connected*, which is a different question - and since the catalog skips the focused character, every "Switch to ..." entry read `offline` however many worlds were live. And main's TabExpansionTests asserted two constants against their own literals, which TUnit's analyzer refuses; they are behavioural now. New `characters` snapshot view: two characters genuinely open, the one state the Alt-J/Alt-K column can be seen in and the one thing `connections` cannot fake. Core 813, Graphics 83, Scripting 42, Web 37, Tui 1355. Warning-free. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GpL7Ht6sLBsSEtVNsYcXMM
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.
docs/HANDOFF.mdarrived onmainvia PR #2. It was written earlier and never updated, so itdirected whoever picks up the work next to paths that no longer exist:
dotnet build MuGlyph.slnxsrc/MuClient.Tui/MuGlyphApp.csdotnet run --project tests/MuClient.Core.Testsdotnet run --project src/MuClient.TuiFollowing the document as written fails at the first command.
Changes
status. It previously described an unmerged branch and an open PR at a repo path that no
longer exists, and told readers to go check whether that branch was still there.
(400).
the next session, not a changelog.
what changed to get here. The reasoning behind the naming lives in
docs/superpowers/specs/2026-07-28-sharpmuterm-naming-design.md, which is where that belongs.Verification
Every path referenced in the document was checked against the tree; all resolve. (
docs/patterns.mdappears in the text but refers to a file in the upstream
nickprotop/ConsoleExrepo, not this one.)Still outstanding
This PR covers
HANDOFF.mdonly. Four files onmainstill carry the old name, all from PR #3:README.md— the<h1>title and logo alt textassets/fonts/MuGlyph.ttf— filename, plus the family name baked into the font binaryassets/fonts/README.mdtools/make-glyph-font.py🤖 Generated with Claude Code
Summary by CodeRabbit
main.