Skip to content

Tutor/shell commands #11307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

jerabaul29
Copy link
Contributor

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

@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label Jul 25, 2024
@jerabaul29
Copy link
Contributor Author

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 :) .

@David-Else
Copy link
Contributor

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

jerabaul29 and others added 4 commits September 11, 2024 12:25
@jerabaul29
Copy link
Contributor Author

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

@jerabaul29
Copy link
Contributor Author

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 :) ).

Copy link
Member

@the-mikedavis the-mikedavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

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. I think mentioning :sh and maybe :insert-output/:append-output/! is good but we can probably skip the pipe commands or mention them but not go into details: I don't think the tutor should be recommending how to set up scripting since that isn't a basic workflow. We can probably solve the Windows problem by keeping it simple and recommending ls on Unix systems and dir on Windows.

@jerabaul29
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants