docs: update keyboard shortcuts section with detailed controls for ma…

…idr interaction
xability · Dec 20, 2024 · dd3b79f · dd3b79f
1 parent bf71a01
commit dd3b79f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/docs/examples.qmd b/docs/examples.qmd
@@ -185,7 +185,18 @@ Check out [this interactive notebook in Google Colab](https://colab.research.goo
 
 We provide [some example code](https://github.com/xability/py-maidr/blob/main/example) for using py-maidr with matplotlib, seaborn, Jupyter Notebook, Quarto, Shiny, and Streamlit.
 
-## Keyboard Shortcuts
+## Keyboard Shortcuts and Controls
+
+To interact with the plots using maidr, follow these steps:
+
+1. Press the **Tab** key to focus on the plot element.
+2. Use the **arrow keys** to move around the plot.
+3. Press **B** to toggle Braille mode.
+4. Press **T** to toggle Text mode.
+5. Press **S** to toggle Sonification (tones) mode.
+6. Press **R** to toggle Review mode.
+
+Below is a detailed list of keyboard shortcuts for various functions:
 
 | Function | Windows and Linux Key | Mac Key |
 |:---|:---|:---|

diff --git a/docs/index.qmd b/docs/index.qmd
@@ -143,7 +143,18 @@ plt.ylabel("Body Mass (g)")
 maidr.show(bar_plot) #<<
 ```
 
-## Keyboard Shortcuts
+## Keyboard Shortcuts and Controls
+
+To interact with the plots using maidr, follow these steps:
+
+1. Press the **Tab** key to focus on the plot element.
+2. Use the **arrow keys** to move around the plot.
+3. Press **B** to toggle Braille mode.
+4. Press **T** to toggle Text mode.
+5. Press **S** to toggle Sonification (tones) mode.
+6. Press **R** to toggle Review mode.
+
+Below is a detailed list of keyboard shortcuts for various functions:
 
 | Function | Windows and Linux Key | Mac Key |
 |:---|:---|:---|