docs: Update docs

Add more sections and refer to the new ARCHITECTURE.md file. Minor cleanups. Signed-off-by: Simen S. Røstad <[email protected]>
hello-nrfcloud · Nov 19, 2024 · 43c084f · 43c084f
1 parent f5cd069
commit 43c084f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -101,8 +101,7 @@ Experimental: You can update the modem firmware using pyOCD. A simple way to do
 python3 scripts/nrf91_flasher.py -m mfw_nrf91x1_2.0.1.zip
 ```
 
-
-### LED pattern
+## LED pattern
 
 | LED effect     | Color      | Meaning                                      | Duration (seconds)                                  |
 |----------------|------------|----------------------------------------------|-----------------------------------------------------|
@@ -113,23 +112,34 @@ python3 scripts/nrf91_flasher.py -m mfw_nrf91x1_2.0.1.zip
 | Blinking rapid | Red        | Fatal error, the device will reboot          | NA                                                  |
 | Blinking slow  | Red        | Irrecoverable Fatal error                    | NA                                                  |
 
+## Architecture
+
+Documentation on the overall architecture of the firmware can be found in the document [Architecture](docs/ARCHITECTURE.md).
+
+## Troubleshooting
+
+The following section contains guidelines on how to troubleshoot issues with the device.
+
 ### Modem Traces
 
-Modem traces are enabled by default on the Thingy:91 device. These traces can be output to UART for analysis using the **nRF Connect for Desktop Cellular Monitor** application.
+Modem traces are enabled by default on the Thingy:91 X and continously stored to external flash. These traces can be output to UART for analysis using the **nRF Connect for Desktop Cellular Monitor** application.
 
 #### Steps to Capture and Dump Modem Traces:
 
 1. **Connect to a Serial Terminal**
-   - Connect your Thingy:91 device to a serial terminal on **UART 0**. This will allow you to interact with the device's shell commands. You might need to push **Button 1** to wake the UART up.
+   - Connect your Thingy:91 X to a serial terminal on **UART 0**. This will allow you to interact with the device's shell commands. You might need to push **Button 1** to wake the UART up.
 
 2. **Set Up Cellular Monitor Application**
    - Open the [Cellular Monitor Application](https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/index.html).
-   - Connect the Thingy:91 to the application, select **UART 1** as the trace output, and click **Start Traces** to begin capturing modem activity.
+   - Connect the Thingy:91 X to the application, select **UART 1** as the trace output, and click **Start Traces** to begin capturing modem activity.
 
 3. **Dump Traces via UART**
+   - Ensure that the error scenario has been captured. Note that older traces will be overwritten by new ones when the flash buffer is full, so ensure that the issue you want to troubleshoot has occured relatively recent to dumping of the traces over UART.
    - Use the following shell commands in the connected serial terminal to manage and dump the modem traces on **UART 1**:
 
    ```shell
    modem_trace stop         # Stop modem tracing if running
    modem_trace size         # Check the size of stored traces
    modem_trace dump_uart    # Dump traces to UART 1 for analysis
+
+## Known issues
diff --git a/ARCHITECTURE.md → docs/ARCHITECTURE.md b/ARCHITECTURE.md → docs/ARCHITECTURE.md