content: Improvements to the Raph Rover docs #115
Conversation
Co-authored-by: Jan Hernas <jasiex01@users.noreply.github.com>
Co-authored-by: Jan Hernas <jasiex01@users.noreply.github.com>
Krzemien97
changed the title
Deploying fictionlab-docs with
|
| Latest commit: |
12b1979
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://13d3a967.fictionlab-docs.pages.dev |
| Branch Preview URL: | https://feature-raph-docs-improvemen.fictionlab-docs.pages.dev |
bjsowa
changed the title
There was a problem hiding this comment.
Pull request overview
This PR significantly enhances the Raph Rover documentation by adding comprehensive user guides and improving the overall structure. The additions focus on practical usage, maintenance, and configuration information for robot operators.
Key Changes
- Added a complete Web User Interface documentation page with feature descriptions and usage instructions
- Created a comprehensive User Manual covering safety, operations, maintenance, and troubleshooting
- Updated metadata and descriptions across multiple documentation files for better SEO and clarity
Reviewed changes
Copilot reviewed 14 out of 18 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
docs/raph-rover/index.mdx |
Updated title and keywords to better reflect ROS 2 platform focus |
docs/raph-rover/documentation/web-user-interface.mdx |
New comprehensive guide for the web UI with screenshots and feature descriptions |
docs/raph-rover/documentation/user-manual/user-manual.mdx |
New main user manual page with safety guidelines and operational procedures |
docs/raph-rover/documentation/user-manual/software-and-hardware.mdx |
New detailed documentation of software architecture and hardware components |
docs/raph-rover/documentation/user-manual/payload-integration-basics.mdx |
New guide for mounting payloads and using external ports |
docs/raph-rover/documentation/user-manual/maintenance-and-troubleshooting.mdx |
New maintenance procedures including battery management and inspection |
docs/raph-rover/documentation/user-manual/control-and-basic-operations.mdx |
New guide covering connectivity, LED signals, and rover control methods |
docs/raph-rover/documentation/user-manual/styles.module.css |
Moved CSS animations from parent directory to user-manual subdirectory |
docs/raph-rover/documentation/user-manual/_category_.json |
Added category configuration for User Manual section |
docs/raph-rover/documentation/specification.mdx |
Added wheel specifications and removed orphaned CSS import |
docs/raph-rover/documentation/ros-api.mdx |
Updated topic names and removed unimplemented features |
docs/raph-rover/documentation/getting-started.mdx |
Streamlined by removing duplicated maintenance content, linking to new documentation |
| Image files | Added various WebP images for UI screenshots and manual illustrations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
docs/raph-rover/documentation/user-manual/maintenance-and-troubleshooting.mdx
Outdated
Show resolved
Hide resolved
docs/raph-rover/documentation/user-manual/payload-integration-basics.mdx
Outdated
Show resolved
Hide resolved
Bitterisland6
left a comment
Bitterisland6
left a comment
There was a problem hiding this comment.
There is only one typo that needs to be fixed. Most of my comments are just some suggestions open for discussion.
| | :---------------------------------------------------------------: | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | | ||
| | <span className={styles.circle} id={styles.green}/> | Green, constant - side panels | Battery state - indicates current battery level. Can be activated by pressing the <font color="2c71bf"> **POWER** </font> button when the charger is disconnected. Each side panel corresponds to a battery on the robot. | 106 | | ||
| | <span className={styles.circle} id={styles.chargeCycle}/> | Color corresponding to battery charge, breathing - side panels | Battery charging - indicates charging and shows current battery charge. When fully charged, the side panel light up green and stops breathing. Charging animation can be disabled by pressing <font color="2c71bf"> **POWER** </font> button when charging. | 51 | | ||
| | <span className={styles.bar} id={styles.batteryConnected}/> | Color corresponding to battery charge - side panels | Battery connected - indicates that a battery was connected successfully. | 108 | |
There was a problem hiding this comment.
The LED description of this and the previous state are almost identical which is a little confusing. If i understand correctly the breathing animation is displayed during charging, but this one is a single color corresponding to the current battery level, right?
Imo if its possible to reverse the animation (from full green slider to empty / reddish) its going to be a bit more clear that this is supposed to represent the battery being discharged.
There was a problem hiding this comment.
The difference between these states is that first one (breathing) is displayed during charging (so your assumption is correct). Second one (with the slider) is displayed during battery connection. @jasiex01 can you make extract the "State action" into separate column? So for example in this case, state actions would be "Battery charging" & "Battery connected". I think it will make it more clear.
| 4. Remove top electronics cover (you can use handle next to the lidar). | ||
| 5. Inspect for any loose cables water ingress etc. | ||
|
|
||
| {/* TODO: drawing? */} |
There was a problem hiding this comment.
Drawing would be really nice here. Let's not forget about this TODO.
There was a problem hiding this comment.
I wrote this down as Monday task. We will do that later.
| 5. Rotate the robot upside down | ||
| 6. Unscrew 8 torx screws on the bottom of the robot | ||
| 7. Carefully remove the floor with electronics | ||
|
|
There was a problem hiding this comment.
Maybe we should also consider adding some drawings here with the screws placement. (in a from of a comment for now.
There was a problem hiding this comment.
I wrote this down as Monday task. We will do that later.
| This user manual provides concise, practical guidance for safely operating, | ||
| maintaining, and troubleshooting the Raph Rover. Use this manual as the primary | ||
| reference for day-to-day use and field maintenance; follow links to Getting | ||
| Started, developer guides, and the ROS API for setup and advanced development. |
There was a problem hiding this comment.
developer guides refers to Advanced Guides right? Also maybe the texts here could be actual links to the articles.
There was a problem hiding this comment.
Something was wrong with this sentence. I rephrased this section.
| - **Service options** (7): Access additional services such as restarting or | ||
| shutting down the on-board computer. | ||
|
|
||
| ## Extending the UI |
There was a problem hiding this comment.
Are we sure we want inform users about this option? For Leo robot there was a moment, when we had guides about custom UI, but later they were removed.
There was a problem hiding this comment.
I think this information can stay. It's just a note that UI is open-source. We are not against modifications of the UI, but we don't provide guides for it.
Uh oh!
There was an error while loading. Please reload this page.