Skip to content

Improve discoverability of the quick start page #4

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

Open
ItsHarper wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve discoverability of the quick start page #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cd5361
Add link to quick start to the homepage
ItsHarper Jun 22, 2025
ad0ac8c
Add Quick Start to the sidebar
ItsHarper Jun 22, 2025
7f5eb39
Better distinguish between tutorials and quick start
ItsHarper Jun 22, 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
5 changes: 4 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ The Key Mapper documentation aims to provide users with a comprehensive guide to

--8<-- "preamble.md"

!!! question "Want a tutorial?"
!!! tip "Get started"
The best way to get started is with our [Quick Start Guide](quick-start.md).

!!! question "Want a tutorial for something specific?"
We've made some [handy tutorials](tutorials-index.md) to help you learn Key Mapper.

!!! discord "Want to ask for help?"
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ site_url: https://docs.keymapper.club/
use_directory_urls: true
nav:
- Home: index.md
- Quick Start: quick-start.md
- Troubleshooting: faq.md
- Tutorials:
- Make a volume button toggle the flashlight on the lockscreen: tutorials/simple-volume.md
Expand Down