docs(key-bindings): update widget descriptions #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…search" This reflects the change in atuinsh/atuin#1631
This describes the widgets and options introduced by atuinsh/atuin#1570
|
I've been trying to find a way of handling doc versioning a bit better, but it doesn't look like starlight supports git tags or anything. so what you've done here will be the best option for now I think |
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit b8c6b9a corresponds to the widget name change introduced in atuinsh/atuin#1631. Also, the current documentation diverges from the current implementation. I updated the widgets for the up key in commit 6e1f3df. Also, the descriptions for the newly added widgets for
keymap_mode(atuinsh/atuin#1570) are added in commit 705214a.Since the version dependence of documentation can confuse people as in atuinsh/atuin#1625, I decided to add a note on the version dependence and also a required version for each feature. I personally think it is useful to maintain in the documentation the minimal version requirement for each feature, but this might be the perspective of a developer who needs to consider the compatibility of products with arbitrary versions of other products. If you have a different preference, please tell me that.
There is an extra commit 33a1d6d. Sorry, this is unrelated to the widget name but a tiny clarification of a description I added in my previous PR #10. If I should submit a change in a separate PR, please tell me that. It's a small change, but I'll create a separate one if you'd prefer it.