Add contributor how-to: Editing keybindings#586
Conversation
| ### What selector string do I need? | ||
|
|
||
| Probably `.data-jgis-keybinding`! | ||
| _TODO: What do "selectors" do?_ |
There was a problem hiding this comment.
Would appreciate some input :)
There was a problem hiding this comment.
The selector field defines which elements the keybinding applies to.
This ensures that the keybinding only applies when a relevant JupyterGIS UI component is in focus.
For JupyterGIS, we typically use:
.data-jgis-keybinding
because we've added this css class to the application shell here.
You'll notice when you click outside JupyterGIS (e.g., on JupyterLab’s top menu), the keybindings will no longer work. However, clicking back inside JupyterGIS will reactivate them.
There was a problem hiding this comment.
Wonderful, thank you for the extra context :D
|
Integration tests report: appsharing.space |
|
I'm rebasing the branch to also trigger CI |
|
No idea why RTD is failing, however lite ui tests should be fixed after #589 hopefully |
I'll work on this in a little while :) |
| ```{toctree} | ||
| :maxdepth: 1 | ||
| :titlesonly: | ||
| :maxdepth: 2 |
There was a problem hiding this comment.
Don't show h2 headings, only show document titles. To a depth of 2.
for more information, see https://pre-commit.ci
Subdirectory structure will allow us to keep tutorial images (of which there are likely to be many) alongside their corresponding tutorials.
A how-to is less hands-on and step-by-step than a tutorial, and provides more context for learners who have more specific needs, i.e. need more than just an on-rails introduction.
cc38088 to
6d76d2b
Compare
|
Hope y'all don't mind a YOLO merge on these docs PRs. I'd like to make these available to contributors ASAP so we can get feedback from new contributors trying these tasks for the first time. |
Description
Add documentation to help contributors edit keybindings
Checklist
Resolves #XXX.Failing lint checks can be resolved with:
pre-commit run --all-filesjlpm run lint📚 Documentation preview: https://jupytergis--586.org.readthedocs.build/en/586/
💡 JupyterLite preview: https://jupytergis--586.org.readthedocs.build/en/586/lite