Updated docs for missing informations_#59
Updated docs for missing informations_#59paemlaban wants to merge 2 commits intoUbiquityRobotics:jazzy-develfrom
Conversation
Solved github issues: UbiquityRobotics#54 UbiquityRobotics#55 UbiquityRobotics#56 * how to turn off robot section * windows mentioned in connecting section * troubleshooting section update
| | | ||
|
|
||
|
|
||
| .. .. important:: |
There was a problem hiding this comment.
This shouldn't be here.
From where did it come from? Did we make a mistake in the past?
I thought I cleared this from jazzy-devel.
If you create a fresh branch directly from jazzy-devel this shouldn't exists.
Check code-page: https://github.com/UbiquityRobotics/learn2/blob/jazzy-devel/docs/driving/connecting.rst?plain=1
There was a problem hiding this comment.
I looked into it in details, I can see what happened now:
You created /feature branch from jazzy branch directly.
You should create /feature branch from jazzy-devel branch and then push to jazzy-devel.
| @@ -0,0 +1,33 @@ | |||
| Quick Troubleshooting Tips | |||
There was a problem hiding this comment.
I like having a quick troubleshooting section. However, for now we only added specific troubleshooting steps inside the explanation pages.
Do you think having a separate troubleshooting section with drop-downs should be added?
If yes, then I wouldn't use raw html here. "Sphinx" - the documentation library that we are using, already has an extension called "sphinx-design" that does this>
Here is how it looks by default:
When it is opened:
I can add this for you guys in the next PR, and then we can discuss how we would like to use it.
There was a problem hiding this comment.
And the code is pretty simple:
.. dropdown:: **On/off switch is not working**
The issue may be caused by an intermittent internal hardware contact.
Try pressing the switch firmly, or give the switch area a light tap.
So you would mitigate all of this raw html stuff.
|
|
||
| <details> | ||
| <summary><strong>Motors/robot are not moving</strong></summary> | ||
| <p>Restart the robot and test movement again.</p> |
There was a problem hiding this comment.
I would add, restarting the MCB first, then restarting the robot fully.
Maybe some pictures as well, more explanation also.
| <summary><strong>Robot cannot find the local network</strong></summary> | ||
| <p>First, list nearby Wi-Fi networks from the robot:</p> | ||
| <pre><code>nmcli device wifi list</code></pre> | ||
| <p>If your local Wi-Fi (SSID) does not appear in the list, restart the robot and try connecting again.</p> |
There was a problem hiding this comment.
Does this really work? What if it doesn't?
There are few steps that you can do to set up the NetworkManager of the robot to look for certain wifi's. I would add these steps.
Paveljolak
left a comment
Paveljolak
left a comment
There was a problem hiding this comment.
Overall good additions to the documentation.
I will not close this PR, but I suggest you do the following:
- Close the PR.
- Open another
\featurebranch SPECIFICALLY FROMjazzy-develbranch and copy the work that you did here to there. - Open a new PR.
If you would like before opening the new PR I can add the extension for the dropdown menus so we do not clutter stuff with raw html's. Just send me a message.
2 participants
Solved github issues: #54 #55 #56