Skip to content
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

Add tutor entry about 2-character label jump #11273

Merged
merged 3 commits into from
Jul 23, 2024

Conversation

jerabaul29
Copy link
Contributor

This is just a simple addition to the tutor file to document the gw 2-character label jump motion.

@pascalkuthe
Copy link
Member

while I love the jump mode I don't consider it a part of the core editor primitives. I think we should consider keeping the tutor lean and instead moving documentation for more advanced features to a :help command as to not overload beginners

@jerabaul29
Copy link
Contributor Author

If there is consensus on this then this is fine to me naturally :) . However, as a new user a few months ago, I found that the tutor is very effective as it gives good examples and a curriculum to follow / exercises to train muscle memory. I also felt that it was much easier for me to discover features by following the tutor compared to reading the manual which was a bit overwhelming / dry in my taste (I think the doc / manual is better suited as a lookup for people who already know more or less what exists :) ). So I would have liked to have this in the tutor.

But it may just be my personal taste.

@jerabaul29
Copy link
Contributor Author

Would moving this lower down in the tutor, to a short new "advanced motion" section, be ok for you - then it does not overwhelm the beginner early on in the tutor, but it is still taught?

@jerabaul29
Copy link
Contributor Author

jerabaul29 commented Jul 22, 2024

Or do you mean that we should have both hx --tutor to teach only the basics and :help from within helix to open a second, more advanced tutor?

@pascalkuthe
Copy link
Member

I see this kind of thing fitting in with #997. I hope we can merge this in the near future and move a lot of docs there.

Maybe an advanced section of the tutor also makes sense (to give users an idea what features even exist). What do you think @the-mikedavis

@RoloEdits
Copy link
Contributor

I think it would definitely be very beneficial to expose people to some concepts as early as possible, even if its not considered a "core" of helix. Some of these "extras" could offer a foundational change to someone interacting with their editor. Adding an advanced section to the tutor would open up an area to expose workflows that could offer similar opportunities.

@jerabaul29
Copy link
Contributor Author

To add on what you write: I heard about gw because I accidentally landed on a release description page mentioning it - otherwise I would have missed it. It would have been very helpful for me a few months ago to go through it once in the tutor to discover it earlier :) .

@the-mikedavis
Copy link
Member

the-mikedavis commented Jul 23, 2024

Yeah I imagine gw would fit well into :help (#997). I'm not opposed to putting it in the tutor too though since it should just take one section. Maybe it would fit better into chapter 9 though? I see it as sort of similar to search (/)

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

If I get green light to put this into the tutor I can easily move it to section 9 or keep it where it is when you let me know what final decision is made :) .

I would love to keep this in the tutor, but if it is declined I can move into :help when it lands, and / or offer my own separate "more in depth" tutor on a separate website :) .

@pascalkuthe
Copy link
Member

I think moving it to section 9 and merging is fine for now. We can always reorganize the tutor later (or move it to :help)

@jerabaul29
Copy link
Contributor Author

Done moving the gw tutor to chapter 9 :) .

runtime/tutor Outdated Show resolved Hide resolved
@pascalkuthe pascalkuthe merged commit 4c18355 into helix-editor:master Jul 23, 2024
6 checks passed
SofusA pushed a commit to SofusA/helix-pull-diagnostics that referenced this pull request Aug 4, 2024
* Add tutor entry about 2-character label jump

* Move gw tutor to chapter 9

* Do not explicitely say which labels are shown following gw
mxxntype pushed a commit to mxxntype/helix that referenced this pull request Aug 14, 2024
* Add tutor entry about 2-character label jump

* Move gw tutor to chapter 9

* Do not explicitely say which labels are shown following gw
stackotter pushed a commit to stackotter/helix that referenced this pull request Aug 28, 2024
* Add tutor entry about 2-character label jump

* Move gw tutor to chapter 9

* Do not explicitely say which labels are shown following gw
@jerabaul29 jerabaul29 deleted the doc/gw branch September 10, 2024 20:25
kyruzic pushed a commit to kyruzic/helix that referenced this pull request Sep 27, 2024
* Add tutor entry about 2-character label jump

* Move gw tutor to chapter 9

* Do not explicitely say which labels are shown following gw
@Omnikar
Copy link
Contributor

Omnikar commented Oct 2, 2024

I see this kind of thing fitting in with #997. I hope we can merge this in the near future and move a lot of docs there.

Maybe an advanced section of the tutor also makes sense (to give users an idea what features even exist). What do you think @the-mikedavis

What's preventing #997 from being merged?

@the-mikedavis
Copy link
Member

It just needs another round of review. It's been sitting in my 'todo' queue for way too long, I'll take a look at it again this morning

plul pushed a commit to plul/helix that referenced this pull request Oct 13, 2024
* Add tutor entry about 2-character label jump

* Move gw tutor to chapter 9

* Do not explicitely say which labels are shown following gw
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.

5 participants