zmkfirmware / zmk

ZMK Firmware Repository
https://zmk.dev/
MIT License
2.48k stars 2.55k forks source link

feat(docs) Splitting up the troubleshooting page #2319

Closed Nick-Munnich closed 2 weeks ago

Nick-Munnich commented 1 month ago

This PR splits up the troubleshooting page into three parts:

I intentionally made the minimal changes possible to make this easier to review than #2272 - all of the content is lifted directly from the current troubleshooting sections in getting-started/troubleshooting and features/bluetooth. Some additional lines were added to make it tidy, and some headers depth was changed.

I believe this would make it easier for users to find the information corresponding to a particular problem. Another goal is to make it easier to expand on the troubleshooting section in the future. Among other things I would like to add a "hardware issues" page to the three in a future PR.

Nick-Munnich commented 3 weeks ago

Had a look at the changed level 4+ headers just to double check - looks all good to me.

caksoylar commented 2 weeks ago

Thanks @Nick-Munnich! Sorry that I forgot to add you as co-author in the rebase so it didn't show up in Github without squashing.