From a6d75831d91315864ceb17b1008c6fe39fc53177 Mon Sep 17 00:00:00 2001 From: ShilpaG <129755123+ShilpaG813@users.noreply.github.com> Date: Mon, 24 Nov 2025 20:39:16 +0530 Subject: [PATCH 1/3] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 8bbea4327e..e77ecaa29e 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,25 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C * [Filter Reference](./docs/filter-reference.md) * [Maintainers’ Guide](./docs/maintainers.md) +## DevDocs Quick Usage Cheatsheet + +Below are some helpful shortcuts and usage tips that are not immediately obvious to new users: + +- Press **/** or **Ctrl + K** to instantly focus the search bar. +- Press **?** to open DevDocs’ built-in help overlay. +- Press **↑ / ↓** to navigate search results without touching the mouse. +- Press **Enter** to open the highlighted search result. +- Press **Backspace** to go back to the previously viewed page. +- Press **Shift + S** to toggle the sidebar visibility. +- Press **A** to open the list of all installed documentation sets. +- Press **Esc** to close popups, overlays, and search. +- Use the **⚡ Offline Mode toggle** to download docs for offline use. +- You can pin specific documentation sets to the sidebar for quicker access. + +These shortcuts make DevDocs faster to navigate and more efficient for daily use. +These shortcuts make DevDocs faster to navigate and more efficient for daily use. + + ## Related Projects Made something cool? Feel free to open a PR to add a new row to this table! You might want to discover new projects via https://github.com/topics/devdocs. From ee2dda9970bd42b14f7ba525910c847357d8a182 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 7 Dec 2025 14:18:17 +0100 Subject: [PATCH 2/3] Remove duplicate sentence in README Removed duplicate sentence about DevDocs shortcuts. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index e77ecaa29e..c37380e359 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,6 @@ Below are some helpful shortcuts and usage tips that are not immediately obvious - You can pin specific documentation sets to the sidebar for quicker access. These shortcuts make DevDocs faster to navigate and more efficient for daily use. -These shortcuts make DevDocs faster to navigate and more efficient for daily use. ## Related Projects From 00d76ac084b0785242ef1ff4905bbc30d68af1e3 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 7 Dec 2025 14:19:49 +0100 Subject: [PATCH 3/3] Improve formatting of DevDocs shortcuts in README Updated keyboard shortcuts to use kbd tags for better formatting. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c37380e359..e018c34b65 100644 --- a/README.md +++ b/README.md @@ -167,14 +167,14 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C Below are some helpful shortcuts and usage tips that are not immediately obvious to new users: -- Press **/** or **Ctrl + K** to instantly focus the search bar. -- Press **?** to open DevDocs’ built-in help overlay. -- Press **↑ / ↓** to navigate search results without touching the mouse. -- Press **Enter** to open the highlighted search result. -- Press **Backspace** to go back to the previously viewed page. -- Press **Shift + S** to toggle the sidebar visibility. -- Press **A** to open the list of all installed documentation sets. -- Press **Esc** to close popups, overlays, and search. +- Press / or Ctrl + K to instantly focus the search bar. +- Press ? to open DevDocs’ built-in help overlay. +- Press ↑ or ↓ to navigate search results without touching the mouse. +- Press Enter to open the highlighted search result. +- Press Backspace to go back to the previously viewed page. +- Press Shift + S to toggle the sidebar visibility. +- Press A to open the list of all installed documentation sets. +- Press Esc to close popups, overlays, and search. - Use the **⚡ Offline Mode toggle** to download docs for offline use. - You can pin specific documentation sets to the sidebar for quicker access.