Skip to content

docs: add DevDocs quick usage cheatsheet section #2628

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.

Sign up for GitHub

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

Merged
simon04 merged 3 commits into from
Dec 7, 2025
Merged

docs: add DevDocs quick usage cheatsheet section #2628

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6d7583
Update README.md
ShilpaG813 Nov 24, 2025
ee2dda9
Remove duplicate sentence in README
simon04 Dec 7, 2025
00d76ac
Improve formatting of DevDocs shortcuts in README
simon04 Dec 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,24 @@ 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 <kbd>/</kbd> or <kbd>Ctrl + K</kbd> to instantly focus the search bar.
- Press <kbd>?</kbd> to open DevDocs’ built-in help overlay.
- Press <kbd>↑</kbd> or <kbd>↓</kbd> to navigate search results without touching the mouse.
- Press <kbd>Enter</kbd> to open the highlighted search result.
- Press <kbd>Backspace</kbd> to go back to the previously viewed page.
- Press <kbd>Shift + S</kbd> to toggle the sidebar visibility.
- Press <kbd>A</kbd> to open the list of all installed documentation sets.
- Press <kbd>Esc</kbd> 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.


## 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.
Expand Down