doc: add documentation framework and basic docs #239
Conversation
Added documentation framework files required for publishing. Added basic docs. NCD-686. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
added
documentation
doc/docs/overview.md
Outdated
| ### Select Device | ||
|
|
||
| Dropdown to list the devices attached to the computer. When you select a [supported device](index.md#supported-devices), the app programs the device with the sniffer firmware, and then connects to one of the available serial ports. Sniffing starts automatically. | ||
|
|
||
| ## After selection | ||
|
|
||
| When a device is selected, sniffing in the 2.4 GHz range starts automatically and the side panel options become available. | ||
|
|
||
|  | ||
|
|
||
| ### Controls | ||
|
|
||
| This side panel area contains buttons that control the sniffing process: | ||
|
|
||
| - **Start** and **Pause** - Lets you start or pause the sniffing process. | ||
| - **Reset** - Lets you reset the sniffing output. | ||
|
|
||
| ### Sweep Scan | ||
|
|
||
| This option lets you control the frequency with which the sniffing scan are run and with which the results are updated in the **RSSI Viewer** tab. | ||
|
|
||
| ### Channel Details | ||
|
|
||
| The options in this area refer to the Bluetooth Low Energy channels displayed in the **RSSI Viewer** tab. | ||
|
|
||
| ### Filters | ||
|
|
||
| The options in this area allows you to filter out specific Bluetooth LE channels and dBm values in the **RSSI Viewer** tab. | ||
| Once you select the values, the sniffing will be performed only within your custom range. | ||
|
|
||
| ### Device | ||
|
|
||
| The **Toggle LED** button lets you toggle the LED on the connected device. | ||
|
|
||
| ## RSSI Viewer tab | ||
|
|
||
| This is the main area of the application where the sniffing results are displayed. Changing the side panel option settings is automatically reflected on the sniffing results when the sniffing is ongoing. | ||
|
|
||
|  |
There was a problem hiding this comment.
Needs review, @kylebonnici . Please answer my questions on chat.
Signed-off-by: Grzegorz Ferenc <[email protected]>
Signed-off-by: Grzegorz Ferenc <[email protected]>
Signed-off-by: Grzegorz Ferenc <[email protected]>
There was a problem hiding this comment.
For such a small app the documentation seems almost unnecessary to me.
AFAICS we replicated similar github workflows for zoomin in many projects.
For the label checker we added a generic workflow in shared and then reference that in the projects (example).
How about if we do something similar for zoomin?
You are probably aware that doc/docs/screenshots/rssi_viewer_showcase.gif shows an old version of the app.
You copied resources/screenshot.gif to doc/docs/screenshots/rssi_viewer_showcase.gif. How about removing the former (and adjusting the link in README.md)? And also removing the unused resources/rssi_viewer.jpg?
README.md
Outdated
| nRF Connect RSSI Viewer is a tool that shows dBm per frequency in the | ||
| 2400-2480 MHz range, and allows you to tweak settings like sweep delay and |
There was a problem hiding this comment.
To fix the linter issue:
| nRF Connect RSSI Viewer is a tool that shows dBm per frequency in the | |
| 2400-2480 MHz range, and allows you to tweak settings like sweep delay and | |
| nRF Connect RSSI Viewer is a tool that shows dBm per frequency in the 2400-2480 | |
| MHz range, and allows you to tweak settings like sweep delay and animation | |
| duration. |
doc/docs/index.md
Outdated
| @@ -0,0 +1,12 @@ | |||
| # nRF Connect RSSI Viewer | |||
|
|
|||
| nRF Connect RSSI Viewer is a cross-platform tool that shows dBm per frequency in the 2.4 GHz range. It scans the 2400-2480 MHz range, records signal level on particular frequencies, and presents combined results in several ways. | |||
There was a problem hiding this comment.
“particular frequencies” and “combined results in several ways” seems a bit wishy-washy to me. How about:
| nRF Connect RSSI Viewer is a cross-platform tool that shows dBm per frequency in the 2.4 GHz range. It scans the 2400-2480 MHz range, records signal level on particular frequencies, and presents combined results in several ways. | |
| nRF Connect RSSI Viewer is a cross-platform tool that shows dBm per frequency in the 2.4 GHz range. It scans the 2400-2480 MHz range, records signal level on the Bluetooth Low Energy channel frequencies, and presents the results. |
doc/docs/overview.md
Outdated
| | Green column | | | ||
| | Blue column | | | ||
| | Dark blue | | | ||
| | Light blue | | | ||
| | Dark green | | | ||
| | Light green | | | ||
| | Numerical value | | |
There was a problem hiding this comment.
Do you need assistance with filling in the meanings here?
There was a problem hiding this comment.
I have just gotten the info needed, just need to write it. Thanks for the offer, though!
Signed-off-by: Grzegorz Ferenc <[email protected]>
There was a problem hiding this comment.
Looks good! 👍
Unless you want to keep it for archaeological reasons, you can also remove resources/rssi_viewer.jpg.
Signed-off-by: Grzegorz Ferenc <[email protected]>
Added documentation framework files required for publishing. Added basic docs.
NCD-686.