-
Notifications
You must be signed in to change notification settings - Fork 12
Fix any "TODO" or "Under construction" sections of the documentation #47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
34fe3d5
First cleanup of 'TODO' and 'under construction' pages
jhiggins-cpr 5c6e3dc
First cleanup of 'TODO' and 'under construction' pages
jhiggins-cpr 4dc02d6
Formatting fixes
jhiggins-cpr 91336c8
Fix link
jhiggins-cpr 3e44ffd
Fixes from code review
jhiggins-cpr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| <center> | ||
| <img | ||
| src="/img/robot_images/jackal_images/robot_jackal_0.png" | ||
| src="/img/robot_images/jackal_images/jackal_banner.png" | ||
| width="400" | ||
| /> | ||
| </center> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| <center> | ||
| <img | ||
| src="/img/robot_images/warthog_images/robot_warthog_0.png" | ||
| src="/img/robot_images/warthog_images/warthog_banner.png" | ||
| width="400" | ||
| /> | ||
| </center> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Integration | ||
| title: Boxer Integration | ||
| sidebar_label: Integration | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Maintenance | ||
| title: Boxer Maintenance | ||
| sidebar_label: Maintenance | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,54 @@ | ||
| --- | ||
| title: Troubleshooting | ||
| title: Boxer Troubleshooting | ||
| sidebar_label: Troubleshooting | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| import ComponentIntroductionBoxer from "/components/introduction_boxer.mdx"; | ||
| import ComponentSupportIntroduction from "/components/support_introduction.mdx"; | ||
| import Support from "/components/support.mdx"; | ||
|
|
||
| <ComponentIntroductionBoxer /> | ||
|
|
||
| :::warning todo—under construction | ||
| <ComponentSupportIntroduction /> | ||
|
|
||
| ::: | ||
| --- | ||
|
|
||
| ## Networking | ||
|
|
||
| ### Not getting Wi-Fi internet connection | ||
|
|
||
| Refer to the [Networking page](/docs/software/networking). | ||
|
|
||
| ### Cannot connect to the robot's computer over a network cable | ||
|
|
||
| Reter to the [Networking page](/docs/software/networking). | ||
|
|
||
| --- | ||
|
|
||
| ## Computer | ||
|
|
||
| ### The computer does not automatically start | ||
|
|
||
| Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx). | ||
|
|
||
| ### The computer keeps reverting to old BIOS settings | ||
|
|
||
| Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx). | ||
|
|
||
| --- | ||
|
|
||
| ## ROS | ||
|
|
||
| ### ROS package is not starting | ||
|
|
||
| Verify the upstart logs, `/var/log/upstart/husky_core.log`, to see if there are any error during upstart. | ||
|
|
||
| ### Sensors are not turning on | ||
|
|
||
| 1. Check that the sensor's User Power connector has the correct voltage. | ||
| 2. If the voltage is correct, then review the [Troubleshooting section for the related sensor](/docs/sensors). | ||
|
|
||
| ## If the Issue Persists | ||
|
|
||
| <Support /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Tutorials | ||
| title: Boxer Tutorials | ||
| sidebar_label: Tutorials | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: User Manual | ||
| title: Boxer User Manual | ||
| sidebar_label: User Manual | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Maintenance | ||
| title: Dingo Maintenance | ||
| sidebar_label: Maintenance | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,54 @@ | ||
| --- | ||
| title: Troubleshooting | ||
| title: Dingo Troubleshooting | ||
| sidebar_label: Troubleshooting | ||
| sidebar_position: 6 | ||
| --- | ||
|
|
||
| import ComponentIntroductionDingo from "/components/introduction_dingo.mdx"; | ||
| import ComponentSupportIntroduction from "/components/support_introduction.mdx"; | ||
| import Support from "/components/support.mdx"; | ||
|
|
||
| <ComponentIntroductionDingo /> | ||
|
|
||
| :::warning todo—under construction | ||
| <ComponentSupportIntroduction /> | ||
|
|
||
| ::: | ||
| --- | ||
|
|
||
| ## Networking | ||
|
|
||
| ### Not getting Wi-Fi internet connection | ||
|
|
||
| Refer to the [Networking page](/docs/software/networking). | ||
|
|
||
| ### Cannot connect to the robot's computer over a network cable | ||
|
|
||
| Reter to the [Networking page](/docs/software/networking). | ||
|
|
||
| --- | ||
|
|
||
| ## Computer | ||
|
|
||
| ### The computer does not automatically start | ||
|
|
||
| Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx). | ||
|
|
||
| ### The computer keeps reverting to old BIOS settings | ||
|
|
||
| Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx). | ||
|
|
||
| --- | ||
|
|
||
| ## ROS | ||
|
|
||
| ### ROS package is not starting | ||
|
|
||
| Verify the upstart logs, `/var/log/upstart/husky_core.log`, to see if there are any error during upstart. | ||
|
|
||
| ### Sensors are not turning on | ||
|
|
||
| 1. Check that the sensor's User Power connector has the correct voltage. | ||
| 2. If the voltage is correct, then review the [Troubleshooting section for the related sensor](/docs/sensors). | ||
|
|
||
| ## If the Issue Persists | ||
|
|
||
| <Support /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Tutorials | ||
| title: Dingo Tutorials | ||
| sidebar_label: Tutorials | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Tutorials | ||
| title: Husky Tutorials | ||
| sidebar_label: Tutorials | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want to change HTML comments with TODO in them? It may be difficult to find these comments in the future. Should these comments be removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For anything I though we might actually fix in the future, I changed "TODO" to "Future". For anything where I thought we were unlikely to spend the time making changes, I simply removed. The example you have noted is a case where I expect we are unlikely to return in the future to add an image of the Dingo with the reference frame.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts?