From 5f35a0bf58d1d2d34081ff39c7465eb61ad4fc34 Mon Sep 17 00:00:00 2001 From: Albert Y <76888457+filterpaper@users.noreply.github.com> Date: Mon, 28 Mar 2022 15:44:34 +0800 Subject: [PATCH] feat(docs): Add note on locating tmp file in GH actions (#1177) Co-authored-by: Dom H <dom@hxy.io> --- docs/docs/troubleshooting.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index bfeaf0ee..0d276553 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -37,6 +37,10 @@ This can be verified by checking the file in question, found in `mkdir/app/build After opening the `<board>.dts.pre.tmp:<line number>` and scrolling down to the referenced line, one can locate errors within their shield's keymap by checking if the referenced keycodes were properly converted into the correct [USB HID Usage ID](https://www.usb.org/document-library/hid-usage-tables-12). +:::note +If you are reviewing these errors in the GitHub Actions tab, the contents of `<board>.dts.pre.tmp` is output (with line numbers) in the next step of the build process. +::: + |  | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | An incorrectly defined keymap unable to compile. As shown in red, `&kp SPAC` is not a valid reference to the [USB HID Usage ID](https://www.usb.org/document-library/hid-usage-tables-12) used for "Keyboard Spacebar" |