TODO Report¶
Scanned roots: /home/runner/work/mkdocs-test/mkdocs-test/docs, /home/runner/work/mkdocs-test/mkdocs-test/snippets
High TODOs¶
Total High TODO matches: 14
| File | Line | Line text |
|---|---|---|
| docs/throttles/index.md | 39 | TODO HIGH - Overview of DCC Accessory Operation |
| docs/throttles/dcc-accessories.md | 3 | TODO HIGH - how to control DCC Accessories. GUI options. NOT serial commands! |
| docs/enhance/rosters.md | 30 | TODO VERY HIGH! - needs detailed instructions for Roster Editing with a Web Browser. Needs to include screenshots! |
| docs/support/ex-csb1/ex-csb1-full-guide.md | 445 | TODO HIGH - USB Connection to JMRI |
| docs/reference/tools/serial-monitor.md | 3 | <!-- TODO change the references on this page/section from the Arduino IDE to VSC/PIO Or add a VSC/PIO section --> |
| docs/reference/serial-commands/serial-command-ff_not_in_nav.md | 36 | * «freqValue» = one of: TODO What is the format of the parameters? |
| docs/reference/serial-commands/serial-command-cc-wifi_not_in_nav.md | 68 | N/A. The EX-CommandStation will restart. TODO VERY HIGH! - This is no longer true |
| docs/reference/serial-commands/serial-command-cc-wifi_not_in_nav.md | 74 | * In every case above, the EX-CommandStation will restart to apply the new settings. You will need to reconnect to the EX-CommandStation with whatever interface you are using. TODO VERY HIGH! - This is no longer true |
| docs/reference/wiring/i2C/i2c-wiring.md | 54 | - When using separate power sources, there is potential for a ground loop. TODO |
| docs/prepare-to-use/installer/platformio.md | 5 | TODO - provide setup help. |
| snippets/ex-installer/startup-logs.md | 1 | TODO Instructions required here to obtain the startup logs from EX-Installer. |
| snippets/configure/config-wifi-esp32-gui-options.md | 61 | TODO VERY HIGH! - The WiFi change limitation has been broken in the latest CS version as anything can be changed via the in-built web server |
| snippets/configure/config-wifi-esp32-gui-options.md | 69 | TODO VERY HIGH! - Changing the WiFi Settings using the EX-CommandStation's own Web Sever |
| snippets/use/connect-and-use-a-wifi-throttle.md | 3 | <!-- TODO need to include an iOS app instructions --> |
Medium priority TODOs¶
Total medium priority TODO matches: 60
| File | Line | Line text |
|---|---|---|
| docs/support/faq.md | 9 | TODO MEDIUM Rework this so that it includes GUI options (EX-WebThrottle, Engine Driver, etc.) |
| docs/support/faq.md | 19 | TODO MEDIUM Rework this so that it includes GUI options (EX-WebThrottle, Engine Driver, etc.) |
| docs/support/ex-csb1/ex-csb1-full-guide.md | 325 | If you are having problems, look at our uploading troubleshooting guide. TODO MEDIUM - find link |
| docs/support/ex-csb1/ex-csb1-full-guide.md | 451 | TODO MEDIUM - Integrated displays |
| docs/reference/command-station-architecture/io-device-drivers.md | 3 | <!-- TODO MEDIUM - change the references on this page from the Arduino IDE to VSC/PIO --> |
| docs/reference/trackmanager/dc-mode-frequency.md | 82 | - TODO MEDIUM - How to effectively use DC mode when using multiple frequencies. |
| docs/reference/tools/index.md | 3 | TODO MEDIUM - Tools overview |
| docs/reference/serial-commands/serial-command-dd-cc-diagnostic-messages_not_in_nav.md | 44 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-jj-mm_not_in_nav.md | 39 | * StashId: Id of the stash to set, clear or get (0 - TODO MEDIUM) |
| docs/reference/serial-commands/serial-command-s-and-hash_not_in_nav.md | 54 | TODO MEDIUM - Response for <J I> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 131 | TODO MEDIUM - Response for <r «loco» «cv»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 143 | TODO MEDIUM - Response for <W CONSIST «loco»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 147 | TODO MEDIUM - Response for <W CONSIST «loco» REVERSE> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 157 | TODO MEDIUM - Response for `<W «cv» «bitValue» «bit»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 171 | TODO MEDIUM - Response for <b «loco» «cv» «bitValue» «bit»> |
| docs/reference/serial-commands/shell_serial-command-xyz_not_in_nav.md | 53 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-slash-latch_not_in_nav.md | 30 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-at_display_not_in_nav.md | 20 | * display: Display, to display the text on TODO MEDIUM What Format is the parameter? |
| docs/reference/serial-commands/serial-command-o_not_in_nav.md | 40 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-aa-and-a_not_in_nav.md | 43 | TODO MEDIUM - responses |
| docs/reference/serial-commands/serial-command-y_not_in_nav.md | 61 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-slash-reserve_not_in_nav.md | 33 | TODO MEDIUM - Responses |
| docs/reference/serial-commands/serial-command-ll_not_in_nav.md | 26 | * eventId: TODO MEDIUM Parameter description |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 33 | * accelerating: TODO MEDIUM parameter description and range of values allowed |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 34 | * braking: TODO MEDIUM parameter description and range of values allowed |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 35 | * momentum: TODO MEDIUM parameter description and range of values allowed |
| docs/reference/serial-commands/serial-command-jj-ll_not_in_nav.md | 23 | * display: *TODO MEDIUM parameter description / explanation |
| docs/reference/serial-commands/serial-command-jj-ll_not_in_nav.md | 24 | * row: TODO MEDIUM parameter description / explanation |
| docs/reference/serial-commands/serial-command-kk_and_k_not_in_nav.md | 26 | * blockid: TODO MEDIUM description |
| docs/reference/serial-commands/serial-command-kk_and_k_not_in_nav.md | 27 | * loco: TODO MEDIUM description |
| docs/reference/serial-commands/serial-command-zz-and-z_not_in_nav.md | 87 | TODO MEDIUM - Response |
| docs/reference/microcontrollers/index.md | 5 | <!-- TODO MEDIUM - change the references on this page/section from the Arduino IDE to VSC/PIO --> |
| docs/reference/configuration/advanced-config-h.md | 3 | <!-- TODO MEDIUM - change the references on this page/section from the Arduino IDE to VSC/PIO --> |
| docs/reference/hardware/ethernet-boards/index.md | 3 | TODO MEDIUM - Move the legacy pages |
| docs/reference/hardware/wifi-boards/index.md | 3 | TODO MEDIUM - Move the legacy pages |
| docs/reference/microcontrollers/esp32/esp32-acebott.md | 99 | TODO MEDIUM - Stacked EX8874 Checklist |
| docs/reference/microcontrollers/esp32/esp32-ex8874.md | 110 | TODO MEDIUM - Stacked EX8874 Checklist |
| docs/reference/microcontrollers/nucleo/nucleo-144-ex8874.md | 59 | TODO MEDIUM - update MotorDrivers.h for D8 |
| docs/reference/microcontrollers/nucleo/index.md | 3 | TODO MEDIUM - Nucleo - Overview page |
| docs/products/ex-sensorcam/ex-sensor-manual-abridged.md | 5 | <!-- TODO MEDIUM - change the references on this page from the Arduino IDE to VSC/PIO --> |
| docs/products/ex-sensorcam/ex-sensorcam.md | 8 | <!-- TODO MEDIUM - change the references on this page from the Arduino IDE to VSC/PIO --> |
| docs/products/ex-sensorcam/installation-guide.md | 3 | <!-- TODO MEDIUM - change the references on this page from the Arduino IDE to VSC/PIO --> |
| docs/products/ex-dccinspector/index.md | 6 | TODO MEDIUM - This page needs to be expanded |
| docs/contributing/code/contributing-code.md | 13 | <!-- TODO MEDIUM - change the references on this page/section from the Arduino IDE to VSC/PIO --> |
| docs/enhance/accessories/solenoid-turnouts.md | 103 | TODO MEDIUM - Add CDU info |
| docs/enhance/exrail/exrail-startup-configuration.md | 20 | TODO MEDIUM - Adding to your myAutomation.h in EX-Installer |
| docs/enhance/exrail/exrail-startup-configuration.md | 26 | TODO MEDIUM - Adding to your myAutomation.h in VSC |
| docs/enhance/exrail/exrail-startup-configuration.md | 39 | TODO MEDIUM - Adding to your myAutomation.h in the Arduino IDE |
| docs/enhance/exrail/exrail-objects-introduction.md | 209 | TODO MEDIUM - Add a diagram for the EX-CSB1 to a PCA9685 |
| docs/enhance/exrail/exrail-objects-introduction.md | 363 | TODO MEDIUM - Link here to recommended pin/vpin allocations etc. |
| docs/enhance/exrail/exrail-objects-introduction.md | 365 | TODO MEDIUM - Add a diagram for the EX-CSB1 to an IO Expander |
| docs/enhance/accessories/i2c/i2c-gpio-expanders.md | 41 | TODO MEDIUM - diagram for connecting the EX-CSB1 to an GPIO Expander via the headers |
| docs/enhance/accessories/i2c/i2c-displays.md | 96 | TODO MEDIUM - diagram for connecting the EX-CSB1 to an oLED via the headers |
| docs/enhance/accessories/i2c/i2c-displays.md | 98 | TODO MEDIUM - diagram for connecting the EX-CSB1 to an oLED via the QWIIC connector |
| docs/prepare-to-use/connecting/connecting-diy.md | 19 | <!-- TODO MEDIUM - This section could be improved. Physically connecting DIY EX-CS to a layout - EX8874 --> |
| docs/prepare-to-use/connecting/connecting-diy.md | 32 | <!-- TODO MEDIUM - This section could be improved. Physically connecting DIY EX-CS to a layout - Standard Arduino Motor Shield --> |
| docs/prepare-to-use/connecting/connecting-ex-csb1.md | 3 | <!-- TODO MEDIUM - this page needs to be expanded --> |
| docs/prepare-to-use/installer/download/download-linux.md | 7 | <!-- TODO MEDIUM - Download and install on Linux - Add screenshots --> |
| snippets/testing/testing.md | 82 | TODO MEDIUM - basic steps for initial testing with a Smart Device over WiFi. needs to be a cut down version of the /throttles/connecting-wifi.md page. |
| snippets/testing/testing.md | 92 | TODO MEDIUM - what to do if any of the initial testing steps fail --> |
Low priority TODOs¶
Total low priority TODO matches: 120