docs: demo gifs, a stats section, and CONTRIBUTING.md - #12
Merged
Conversation
The README described the commands but never showed them. assets/demo.tape records nvim driving the plugin with vhs: the statusline count, :ShepherdCapture turning a TODO comment into an item, :ShepherdList picking one and editing it with a pre-filled quick-add line, then ticking it off, and :Shepherd opening the whole board in the floating terminal. assets/demo-init.lua loads only this checkout — no plugin manager, no other plugins — and assets/demo-seed.sh seeds a throwaway board under mktemp -d with dates relative to the recording day, so nothing touches a real board and the board still looks lived-in when the gif is re-recorded.
CONTRIBUTING.md takes the development detail out of the README: the module layout, what the specs cover and why the logic sits in pure helpers, the stylua and luacheck conventions, and how to re-record the gifs. The README's development section is now the four make targets plus a pointer. assets/stats.tape records :ShepherdStats — the charts need a taller window and a smaller font than the board, since the output is 56 rows and the float only gets 85% of them — and the README gains a stats section for it. The demo gif moves above requirements, and the recording turns the mouse off so navigation is keyboard-only.
jwarykowski
changed the title
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 README described the commands but never showed them, and carried its development detail inline.
gifs
Both scripted with vhs rather than screen-captured, so they can be regenerated whenever the commands, the picker or the statusline change:
assets/demo.gif(1320x800, ~45s, 616K) — above## requirementsassets/stats.gif(1500x1160, ~11s, 164K) — in a new## statssectionDemo shot list: the statusline count ·
:ShepherdCaptureon a-- TODO:comment, prompt pre-filled with the marker stripped ·:ShepherdList→ edit with its pre-filled quick-add line ·:ShepherdList→ done, count drops ·:Shepherdopening the board in the floating terminal with the captured item in it.The recording runs with
mouseempty, so it is keyboard-driven throughout.CONTRIBUTING.md
Takes the development detail out of the README: the module layout (
init.lua/board.lua/health.lua, all of it over the CLI — the plugin never parses a board file), what the specs cover and why logic belongs in pure helpers on_internal, the stylua/luacheck conventions, and how to re-record the gifs. The README's## developmentis now the fourmaketargets plus a pointer.It also records the trap I hit while testing: named boards live under
$XDG_CONFIG_HOME/shepherd/boards/, not wherever$SHEPHERD_TODO_FILEpoints, so a scratch tree for board commands needsXDG_CONFIG_HOMEset too.