Skip to content

docs: Improve troubleshooting order - easier steps first#1697

Merged
rxhanson merged 1 commit intorxhanson:mainfrom
William-Laverty:docs/improve-troubleshooting-order
Jan 30, 2026
Merged

docs: Improve troubleshooting order - easier steps first#1697
rxhanson merged 1 commit intorxhanson:mainfrom
William-Laverty:docs/improve-troubleshooting-order

Conversation

@William-Laverty
Copy link
Contributor

Summary

Reorganizes the troubleshooting section to put simpler and faster fixes at the top.

Changes

  • Lock/unlock Mac is now step 1 (this resolves many issues quickly, as noted in Key binds fail to work suddenly on Mac OS #1655)
  • Grouped steps into logical sections for clarity:
    • Quick fixes (try these first)
    • Diagnose the issue
    • Check for conflicts
    • Advanced troubleshooting
  • Added bold formatting to highlight key actionable steps

Before

Steps were ordered with debug logging first, which requires more effort to understand.

After

Quick fixes like lock/unlock and checking macOS updates come first, making it faster for users to resolve common issues.

Addresses #1668

Reorganizes the troubleshooting section to put simpler and faster
fixes first:

- Lock/unlock Mac is now step 1 (resolves many issues quickly)
- Grouped steps into logical sections: Quick fixes, Diagnose,
  Check conflicts, and Advanced troubleshooting
- Added formatting to highlight key steps

Addresses #1668
@rxhanson rxhanson merged commit 1eaa6dc into rxhanson:main Jan 30, 2026
@rxhanson
Copy link
Owner

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants