helix icon indicating copy to clipboard operation
helix copied to clipboard

Tutor/shell commands

Open jerabaul29 opened this issue 1 year ago • 2 comments

Provide tutor about the "shell command and related" tooling offered by helix: :sh , :insert-output , :pipe , and the likes.

jerabaul29 avatar Jul 24 '24 16:07 jerabaul29

Just a kind reminder on this :) . Any thoughts / comments? @David-Else you have been interested in these "tutor extension" PRs in the past - would be great if you have feedback on this one too :) .

jerabaul29 avatar Sep 10 '24 20:09 jerabaul29

It looks awesome! Sorry I don't have time to give a full review right now, but I have made some suggestions.

David-Else avatar Sep 10 '24 23:09 David-Else

Thanks for the review and your kind words! :) Updated :) .

jerabaul29 avatar Sep 11 '24 10:09 jerabaul29

Not sure who could review / approve this? :) Maybe @pascalkuthe / @the-mikedavis ? :) (sorry if tagging you is too pushy - if so let me know and I wont do it in the future :) taking the liberty to do so here as this is a minor documentation update, so should be quite benign to approve and merge :) ).

jerabaul29 avatar Sep 16 '24 20:09 jerabaul29

Sorry for the delay of answer!

Thank you for your feedback @the-mikedavis ! :) A few questions:

Chapters 14.2 and 14.3 are to tall: each chapter in the tutor should have a fixed height (19 rows I believe, 22 including the header).

Me being curious: is there a strong reason for using exactly 22 rows? I understand it can be a goal if there are no other conflicting "requirements", but in case we have a bit more to explain, is it really a big issue to use a bit more rows? I can cut the chapters in more subchapters though if you want :)

I'm wary of adding this much content about shell interaction especially because it's unix specific: in its current form it's not useful to readers on Windows.

Yes, I understand that this is an issue... At the same time, I guess that many of the power users / command line users are running either on some unix system, or through the WSL? Would it be acceptable to you if I split the chapters to have at least the key simple ones both working on unix and windows?

I would like to keep the jq example if this is possible, because it is a really powerful use example - at least, it was very interesting to me to learn about it. But if you have strong opinions on this, I can remove it.

jerabaul29 avatar Nov 27 '24 20:11 jerabaul29