Documentation updates

Changed license, added lots of ® symbols

LICENSE.txt

@@ -0,0 +1,10 @@
+Copyright 2021 iRobot Corporation.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,6 +1,6 @@
 # create3_docs
 
-Documentation for the iRobot Create3 robot.
+Documentation for the iRobot® Create® 3 Educational Robot.
 
 ### Build the docs locally
 

docs/api/docking.md

@@ -1,6 +1,6 @@
-# Create3 Docking
+# Create® 3 Docking
 
-The Create3 robot is equipped with a docking station to recharge it between experiments.
+The Create® 3 robot is equipped with a docking station to recharge it between experiments.
 
 Through the ROS 2 APIs users can command docking and undocking autonomous behaviors.
 
@@ -38,13 +38,13 @@ This action will fail if the robot is already docked.
 
 ## Docking sensor data
 
-The Create3 robot exposes several docking-related information through its ROS 2 publications.
+The Create® 3 robot exposes several docking-related information through its ROS 2 publications.
 These should allow users to write their own algorithms taking into account the presence of the dock in the environment and even to write their own docking and undocking procedures.
 
 #### IR opcodes
 
-The Create3 docking station transmit several IR signals.
-The Create3 robot is equipped with two different sensors that are capable of detecting them.
+The Create® 3 docking station transmit several IR signals.
+The Create® 3 robot is equipped with two different sensors that are capable of detecting them.
 
 ![Docking signals](data/create3_dock_codes.png)
 

docs/api/reflexes.md

@@ -1,10 +1,10 @@
 # Reflexes
 
-With the word "reflex" we denote a set of autonomous reactive behaviors that the Create3 robot will trigger when it detects obstacles or hazards.
+With the word "reflex" we denote a set of autonomous reactive behaviors that the Create® 3 robot will trigger when it detects obstacles or hazards.
 
 Reflexes are high-priority behaviors and will temporarily override any user-provided command for their short duration.
 
-Reflexes can be enabled or disabled on the Create3 using the corresponding ROS 2 parameters exposed by the `motion_control` ROS 2 node.
+Reflexes can be enabled or disabled on the Create® 3 using the corresponding ROS 2 parameters exposed by the `motion_control` ROS 2 node.
 
 ## Reflex parameters
 

docs/api/ros2.md

@@ -1,6 +1,6 @@
 # ROS 2 APIs
 
-The Create3 robot is based on ROS 2 and, as such, it exposes all its user-facing APIs through ROS 2 entities (topics, services, actions and parameters).
+The Create® 3 robot is based on ROS 2 and, as such, it exposes all its user-facing APIs through ROS 2 entities (topics, services, actions and parameters).
 
 The purpose of this page is to give a quick overview of these ROS 2 APIs.
 If you are interested in more details, have a look at the other pages in this section.

docs/api/safety.md

@@ -1,6 +1,6 @@
-# Create3 Safety Overrides
+# Create® 3 Safety Overrides
 
-By default, the Create3 robot has some safety features enabled.
+By default, the Create® 3 robot has some safety features enabled.
 Their purpose is to make sure that the robot does not get into dangerous sitations and it is able to detect and react properly to cliff hazards.
 
 Safety features are configurable by the user through a ROS 2 parameter.
@@ -22,15 +22,15 @@ The following sections briefly describe what the safety features do.
 
 ## Backup Limit
 
-The Create3 robot is equipped with cliff sensors, but they are located only in the front of the robot.
+The Create® 3 robot is equipped with cliff sensors, but they are located only in the front of the robot.
 This means that the robot is not able to detect cliff hazards while driving backward.
 
 In order to make the robot safe, thus we need to make sure that the robot never moves backward more than what it's safe to do.
 Under standard circumstances, the robot is allowed to briefly move backward only if it has first traveled forward (i.e. if it has "explored" the space making sure that it does not present cliff hazards).
 
 If the robot is kidnapped (i.e. first lifted by the user and then placed somewhere), the backup limit will immediately trigger.
 
-The Create3 robot signals to the user when the backup limit is about to be triggered in multiple ways:
+The Create® 3 robot signals to the user when the backup limit is about to be triggered in multiple ways:
 
  - Through the `HazardDetectionsVector` ROS 2 message: an hazard of type `BACKUP_LIMIT` will be published in the vector.
  - By logging a warning message.

docs/index.md

@@ -1,10 +1,10 @@
-# Welcome to iRobot Create3
+# Welcome to the iRobot® Create® 3 Educational Robot
 
 TODO: add pictures and videos
 
 ### Overview
 
-What is Create3?
+What is iRobot® Create® 3?
 
 ### Useful links
 

docs/robot-setup/robot.md

@@ -1,3 +1,3 @@
 # The Robot
 
-This page describes the Create3 robot.
+This page describes the iRobot® Create® 3 Educational Robot.

docs/robot-setup/webserver.md

@@ -1,6 +1,6 @@
 # Webserver
 
-The Create3 webserver is a web interface for debugging an setting up your robot.
+The iRobot® Create® 3 webserver is a web interface for debugging an setting up your robot.
 
 If the robot is on the same WiFi network as your laptop, then you can access the webserver opening a browser at the following address: `http://irobot-701c264ad869434e8e11deace38d2bb8.local/`.
 Here the string `irobot-701c264ad869434e8e11deace38d2bb8` is the hostname of your robot.
@@ -11,7 +11,7 @@ Provisioning is also required for WiFi ROS 2 connectivity and to have UTC synchr
 
 ## Provisioning 
 
-Provisioning is the procedure that will connect the Create3 robot to your WiFi network.
+Provisioning is the procedure that will connect the Create® 3 robot to your WiFi network.
 
 Press and hold the left ( · ) and right ( · · ) buttons for six seconds.
 The light ring should go cyan.

docs/sim/setup.md

@@ -1,2 +1,2 @@
-# Using the Create3 Simulator
+# Using the iRobot® Create® 3 Simulator
 

mkdocs.yml

@@ -1,7 +1,7 @@
-site_name: Create3 Docs
-site_description: 'Documentation for the iRobot Create3 robot'
+site_name: Create 3 Docs
+site_description: 'Documentation for the iRobot® Create® 3 robot'
 site_author: 'iRobot'
-#site_url: TODO
+#site_url: http://edu.irobot.com/create3/
 
 repo_name: 'iRobotEducation/create3_docs'
 repo_url: 'https://github.com/iRobotEducation/create3_docs'