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

README - transition between modes #127

Merged
merged 6 commits into from
Nov 15, 2024

Conversation

BAlmeidaS
Copy link
Contributor

Adding a small session on the README trying to instruct others to enable a different transition from Normal mode to Jupyter Command mode only with Shift+ESC instead of the default ESC

Related to this issue: #126

@github-actions
Copy link

Binder 👈 Launch a Binder on branch BAlmeidaS/jupyterlab-vim/readme-update

README.md Outdated Show resolved Hide resolved
@krassowski krassowski added the documentation Improvements or additions to documentation label Oct 22, 2023
@krassowski krassowski requested a review from firai November 11, 2023 20:03
@firai
Copy link
Collaborator

firai commented Nov 24, 2023

Thanks for your contribution. Sorry about the delay in reviewing this. I have some ideas about how I would suggest rewording this, but I haven't had time to type it all out and edit it yet.

In the meanwhile, @ianhi and @krassowski, what do you think about the proposed location for placing the new section? The description about modes is near the top of the README, but the reader would need to scroll through installation instructions and the whole list of other shortcuts before they find the proposed section about mode transition shortcuts in the current PR. I'm wondering whether we should at least put the proposed mode transition shortcut section above the other shortcuts.

@krassowski
Copy link
Collaborator

Shourtcut (link) sounds good to me.

@firai
Copy link
Collaborator

firai commented Nov 15, 2024

Thanks for your contribution, @BAlmeidaS! Sorry about the epic delay in reviewing this. I understand that you were trying to make the section small, but the combination of various options and various modes might confuse new users, so I took the chance to expand your PR to be similar to the vim help page. I also added a link from the earlier section describing the modes, based on the discussion above.

@firai firai merged commit c08147b into jupyterlab-contrib:main Nov 15, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants