helix
helix copied to clipboard
helix-editor
Create a tutor entry for using splits
A WIP of a tutor entry about splits.
I have documented what I use myself. I will work a bit further on adding instructions about moving things around etc.
Feel free to give feedback already now if you have some so I both apply it and follow it in the rest of it.
You might also want to mention creating splits directly from file picker.
Ready for review as far as I am concerned :) .
- I have applied the change recommended above
- I have added a section about splitting from the file picker (many thanks for pointing to this, actually I did not know about it ^^ )
Comments/ request for additions and changes are welcome :) .
While this is great content, please could you run it through a spelling and grammar checker? There are a large number of errors, things like unwanted spaces, and typos like 'is is' that really need to be caught before a human review. ChatGPT is the state of the art spelling/grammar checker, but ltex-ls and grammarly are still worth running.
Thanks, I will iterate over the next few days. I have not used chat-gpt but I can give it a test. It is a different topic, but: I have actually discussed here about spell checker, but since it looks like something is in the pipes, I had thought about waiting until it is built in :) . Maybe I should give a go at ltex-ls.
@David-Else : I tried to run this through ChatGPT, but it looks like the "ChatGPT-based grammar check" is only for paid accounts at the moment. The closest I got was running it through my Gmail. It caught a few things that I fixed.
Unfortunately, I am not a native English speaker. I believe this is certainly not perfect oxford English, but that it should be quite understandable for most people who speak "globish" :) . I do not believe there is much more that I can do from my side, so if you want to improve the English, feel free to add a couple of extra commits :) .
So as far as I am concerned, I do not think there is much more that I can do on the language per se. If / when this is merged, I will be happy to work on a similar tutorial for shell and pipe commands in the same style (if this can help "motivate" to merge this ^^ :) ).
@the-mikedavis you had reviewed my similar PR that added chapter 12 a while ago, tagging you just in case you are interested in reviewing this one too :) .
I implemented most of the "specific comment" changes you requested @the-mikedavis :) .
Regarding
I'm a little hesitant to add a section to the tutor on windows because I'm worried people will lose the tutor file by accidentally hitting <C-w>q on the tutor file or something similar. So I think we should keep it simple and only add the basics: what you have as sections 13.1, 13.2 and 13.3. I don't think teaching :vs/:hs is necessary and once you know how to open the window minor mode (C-w) you can discover some of the other commands like swapping splits from the infobox that pops up.
I would like to disagree on this :) . As a user who is learning helix myself, my experience is that it is good to see as many of the different ways to "do things" as possible in the tutor, as, otherwise, I end up having blind spots (for example, I did not know about the opening in split from filepicker). My feeling is that it goes really fast to go through the tutor anyways, and that it is easy to skip sections, so as a user I enjoy better to have in-depth guide.
Similarly about "dangerous" commands like ctrl-w q : I think it is better that this happens to the user while they play around with the tutor (as re-typing helix --tutor is fast and easy) so they learn here that it is a bit dangerous, rather than they hit this accidentally while working on a bit project and loose a big amount of context :) .
Naturally these are just my 2 cents, but I just went / am still going through the onboarding process, so this is based on relatively "fresh" / "n00b" experience. But I guess this also depends on the personality of the user getting onboarded etc :) .
If you have very strong opinions about this, feel free to push a commit that removes the sections you do not like. But for my part, I am not too keen on removing them myself :) .
Fair enough. I suppose you would need to force-quit the tutor buffer anyways since it would most likely have modifications if you did the previous sections
@jerabaul29 Did you get a chance to have a look at my review? I hope you don't think I am being too pedantic, your contribution is very much appreciated!
Hi @David-Else :) Sorry for the absence of reply, things have been hectic at work, which is why I have not had time to work on this further. Really sorry about that, I hope (but not 100% sure) I get time to look into this later this week or next weekend. I really appreciate your comments, no worry at all and nothing else on my side than too much at work :) . If I am still head under water and I do not look at it within a few days, feel free to ping me again in a week-ish - I will try to remember myself but a reminder can help ^^ :) .
Many thanks for the edits @David-Else , sorry it took me so long to look into them. I have merged all of them.
Then I think that if we agree that it is ok to err on the side of "slightly overly detailed to be beginner friendly", this should be more or less ready :) .
(@the-mikedavis is my understanding that you accept my point about being better to mess up while experimenting with the tutor than with real production files correct? If so, do I understand correctly that your request for changes can be closed? :) ).
Just curious: do you think this could be part of the upcoming 24.03 release? :) I think we ironed out most points that were raised, and this is "just" text / tutorials where the points were mostly about taste choices not about correctness? :)
Thanks for the language edits @the-mikedavis , they look good to me, I merged them now :) .