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

Include the list of key bindings (shortcuts) in the documentation #1805

Merged
merged 8 commits into from
Jul 24, 2021

Conversation

rchl
Copy link
Member

@rchl rchl commented Jul 22, 2021

Create a table of supported key bindings / commands in the documentation.

I've also added some missing commands to the sublime-commands file (and removed some that were not working anymore). I'm a bit uncertain if we want them or not there. It looks like maybe we didn't have commands that rely on cursor position there on purpose but then there were exceptions like Rename or Find References so maybe those were just overlooked.

There are also some changes to make naming more consistent across comments in key bindings and command names.

@rchl
Copy link
Member Author

rchl commented Jul 22, 2021

BTW. I'm still not too happy about the situation with shortcuts because both the Features section and the Customization section lists/mentions key shortcuts now (although the list added here is more complete). I think those should be consolidated although I'm not entirely convinced how.

Are keyboard shortcuts a "feature"? Keyboard shortcuts trigger features but is "features" section really a good place for them?

On the other hand, is someone who is looking for a list of shortcuts gonna think to look into Customization? He might be looking for existing shortcuts rather than thinking about customizing anything...

When thinking about those issues I'm trying to put myself in the boots of someone new who doesn't know anything about that package and the current situation doesn't feel ideal then.

EDIT: The solution to that might be to just have a separate section for keyboard shortcuts that would both list them and have some short info about customizing.

@rchl
Copy link
Member Author

rchl commented Jul 22, 2021

OK, refactored more by moving keyboard shortcuts into its own page and then updated the Features page to not list keyboard shortcuts anymore (but link to the shortcuts page instead)

@@ -1,33 +1,18 @@

Copy link
Member Author

Choose a reason for hiding this comment

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

This page should probably only have a high-level overview of the main features with screencasts. The existing content doesn't feel ideal here.

@thomaseizinger
Copy link

I recently adopted this package, coming from IntelliJ Rust and my primary quest was:

I want to reconfigure all the shortscut to be what I am used to.

What I found hard was to figure out, what sublime-lsp actually allows me to do. I didn't care much about existing shortcuts but a complete overview of what I can put into command, args and context to achieve a particular functionality would have been very helpful.

The table you added goes exactly into this direction, so thank you :)

@rwols rwols merged commit 82b237f into main Jul 24, 2021
@rwols rwols deleted the fix/docs-shortcuts branch July 24, 2021 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants