Add screenshots and animated demos to the docs#2098
Merged
Conversation
Illustrate the key features (find file, switch project, the dispatch menu, the search/replace review buffers and named tasks) with scripted, reproducible captures using vertico + marginalia and zenburn.
bbatsov
force-pushed
the
feature/docs-screenshots
branch
from
July 18, 2026 09:04
747513f to
723550c
Compare
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.
The docs have always been a bit of a wall of text. This adds animated demos and screenshots for the key features so people can see them in action instead of just reading about them.
Six visuals, captured from scripted throwaway
emacs -Qsessions (zenburn, vertico + marginalia) so they're consistent and reproducible:usage.adoc: a find-file gif and a switch-project shot in the basic usage section, a replace-review gif and a search-review shot in the two reviewer sections, and a dispatch menu shottasks.adoc: a run-task shotDocs-only, so no tests or changelog entry.
eldev test)M-x checkdocwarnings