Show the keys being pressed in the docs screencasts - #4181
Merged
Conversation
A screencast of a keyboard-driven feature is worth much less when the reader can't see which keys drove it, and the prose around each one had to spell the bindings out to compensate. These are re-recorded with keycast running in the tab bar, so the key and the command it invoked are on screen as the demo runs. The macrostep one now steps through two expansions and collapses back, which is what the surrounding text describes; the other two show the same code as before.
Same treatment as the evaluation ones: keycast in the tab bar, so the inspector, enlighten and debugger demos show which key drove each step rather than leaving the reader to guess from the prose. The inspector demo drills into one of the maps before switching to the table view, so its alt text now describes that order. Also drops cider_debugger.gif, superseded by cider-debugger.gif in July and referenced by no page since.
These three were the holdouts: find-usages and see-also date from 2019 and 2020, the stacktrace one from 2025, and none of them showed the keys either. They are re-shot against the same fixture project as the rest of the set, so the whole docs now demo one codebase in one theme. The error-buffer section only mentioned clicking, but both targets have taken RET and i all along, so it says that now and the screencast uses the keyboard like its neighbours. Sizes come down a long way in passing: 2.2M to 165K, 656K to 94K and 1.4M to 149K.
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.
Every screencast in the docs demonstrates a keyboard-driven feature, and not
one of them showed the keyboard. The prose around each had to name the
bindings to compensate, which asks the reader to hold a sentence in their head
while watching the picture. All of them are re-shot with keycast running in the
tab bar, so the key and the command it invoked sit above the frame as the demo
runs.
They also now share one fixture project and one theme. The set had drifted into
three generations: light-themed captures from July, dark ones from August, and
hand-recorded screencasts going back to 2019 that were never scripted at all.
The three oldest were also enormous, and shrink a long way in the re-shoot:
2.2M to 165K, 656K to 94K, 1.4M to 149K.
Two small doc changes come with them. The inspector alt text follows the new
demo's order, and the error-buffer section now mentions that the exception and
ex-data targets respond to kbd:[RET] and kbd:[i] as well as the mouse, which
they always have.
cider_debugger.gif is deleted: superseded by cider-debugger.gif in July and
referenced by no page since. cider-flash-evaluated-region already had keycast
and is untouched.