Update unboxing_mini.rst #26
Conversation
mostly minor English usage suggestions.
|
please review before committing any changes. |
| ----------- | ||
|
|
||
| - Use a multimeter to confirm voltage. Keep the batteries always charged. | ||
| - Use a multimeter to confirm the voltage. Keep the batteries fully charged.(Confusing, since you then tell them to charge the batteries once they're installed) |
There was a problem hiding this comment.
Here we can add a link to the Batteries Charging guide. We can say use fully charged batteries, followed by
If the batteries are inside the robot, charge with provided charger, otherwise charge with power supply.
Does this make more sense?
There is a proper explanation on charging inside the batteries page. Probably that is why I haven't gone into details for charging in this page. We can also explain it here in more detail, I just don't think charging is the highlight of the unboxing, so just link to the batteries page charging section should be sufficient.
What do you think about this?
| For for exact instructions on how to charge the batteries before adding them to ther robot: :doc:`../requirements/batteries`. | ||
|
|
||
| 1. Inspect Batteries | ||
| 1. Inspect the Batteries |
There was a problem hiding this comment.
When changing the text inside header, sub-headers or any text that has the
"====="
"#####"
"~~~~~~"
"----------"
Be careful with the length of the text and the length of the string below it. They have to be the same otherwise we get syntax warning. They don't necessarily break the build, but they are annoying and show up in red colored warning text. When looking for a real error it's harder to go through all of this annoying warnings so I just have the habit of cleaning them.
To summarize:
If there is a title or a subtitle or subsubtitle (latex term), please note that the length of the symbol string below the title text should be the same as the title text length.
|
|
||
| Install First Battery | ||
| Install the First Battery | ||
| ~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
This needs to match the length of the subtitle above it.
| Install Second Battery | ||
| Install the Second Battery | ||
| ~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Match the length of the subtitle above it.
| Connect Batteries in Series | ||
| Connect the Batteries in Series | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Match the length of the subtitle above it.
| Verify Wiring | ||
| Verify the Wiring | ||
| ~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Same here, match the length of the subtitle above it.
2 participants
mostly minor English usage suggestions.