docs: fix styles (#139)

Signed-off-by: Kenji Miyake <[email protected]>

docs/contributing/coding-guidelines/ros-nodes/message-guidelines.md

@@ -114,7 +114,7 @@ uint8 type
 
 ## Comments
 
-On top of the message, briefly explain what the message contains and/or what it is used for. See [sensor_msgs/msg/Imu.msg](https://github.com/ros2/common_interfaces/blob/master/sensor_msgs/msg/Imu.msg#L1-L13) for an example.
+On top of the message, briefly explain what the message contains and/or what it is used for. For an example, see [sensor_msgs/msg/Imu.msg](https://github.com/ros2/common_interfaces/blob/master/sensor_msgs/msg/Imu.msg#L1-L13).
 
 !!! tip ""
 

docs/contributing/index.md

@@ -19,7 +19,7 @@ Like Autoware itself, these guidelines are being actively developed and suggesti
 
 ## Code of Conduct
 
-To ensure the Autoware community stays open and inclusive, please follow our [code of conduct](https://github.com/autowarefoundation/autoware/blob/main/CODE_OF_CONDUCT.md).
+To ensure the Autoware community stays open and inclusive, please follow the [code of conduct](https://github.com/autowarefoundation/autoware/blob/main/CODE_OF_CONDUCT.md).
 
 If you believe that someone in the community has violated the code of conduct, please make a report by emailing [email protected].
 
@@ -90,4 +90,4 @@ Examples of large changes include:
 - Adding a new feature to Autoware
 - Adding a new documentation page or section
 
-For more information on how to submit a good pull request, have a read of our [pull request guidelines](pull-request-guidelines/index.md) and don't forget to review the required [license notations](license.md)!
+For more information on how to submit a good pull request, have a read of the [pull request guidelines](pull-request-guidelines/index.md) and don't forget to review the required [license notations](license.md)!

docs/contributing/pull-request-guidelines/commit-guidelines.md

@@ -1,7 +1,5 @@
 # Commit guidelines
 
-This page explains our guidelines related to committing.
-
 ## Branch rules
 
 ### Start branch names with the corresponding issue numbers (advisory, non-automated)

docs/contributing/pull-request-guidelines/index.md

@@ -3,20 +3,20 @@
 ## General pull request workflow
 
 Autoware uses the fork-and-pull model.
-Refer to [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) for the detailed explanation of the model.
+For the detailed explanation of the model, refer to [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).
 
-The following is a general example of our pull request workflow.
+The following is a general example of the pull request workflow.
 
 1. Create a fork. (for the first time only)
 2. Create an issue.
    - Discuss the approach to the issue with maintainers.
 3. Write code in the agreed approach.
    - Write the tests and documentation if necessary.
-   - Follow our guidelines when you write code, tests, and documentation.
+   - Follow the guidelines when you write code, tests, and documentation.
      - [Coding guidelines](../coding-guidelines/index.md)
      - [Testing guidelines](../testing-guidelines/index.md)
      - [Documentation guidelines](../documentation-guidelines/index.md)
-   - Follow our [Commit guidelines](commit-guidelines.md) when commit your change.
+   - Follow the [Commit guidelines](commit-guidelines.md) when commit your change.
 4. Test the code.
    - In the later review process, you will need to write what tests you have done.
 5. Create a pull request.
@@ -25,7 +25,7 @@ The following is a general example of our pull request workflow.
      - If you have no rights to assign reviewers, just mention them instead.
      - If you are not sure who to set reviewers, contact to the people written as the `maintainer` tag in `package.xml`.
 6. Wait for the pull request to be reviewed.
-   - The reviewers will review your code following our [review guidelines](review-guidelines.md).
+   - The reviewers will review your code following the [review guidelines](review-guidelines.md).
      - Take a look at the guidelines as well because it is good to understand the thoughts of the reviewer's side.
    - If [CI checks](#ci-checks) have failed, fix the errors.
 7. Address the review comments pointed out by the reviewers.
@@ -63,7 +63,7 @@ The Developer Certificate of Origin (DCO) is a lightweight way for contributors
 This workflow checks whether the pull request fulfills `DCO`.  
 You need to confirm the [required items](https://developercertificate.org/) and commit with `git commit -s`.
 
-Refer to the [GitHub App page](https://github.com/apps/dco) for more information.
+For more information, refer to the [GitHub App page](https://github.com/apps/dco).
 
 ### semantic-pull-request
 
@@ -75,9 +75,9 @@ Note that if there is only one commit in the pull request, you need to make the
 This is due to GitHub's non-intuitive behavior when there is only one commit.
 GitHub uses the commit title for the squashed commit message, instead of the pull request title.
 
-Refer to [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) for more detailed behaviors of this workflow.
+For more detailed behaviors of this workflow, refer to [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request).
 
-See our [commit guidelines](commit-guidelines.md) for the detailed rules.
+For the detailed rules, see the [commit guidelines](commit-guidelines.md).
 
 ### pre-commit
 
@@ -125,7 +125,7 @@ This workflow is the `ARM64` version of `build-and-test-differential`.
 You need to add the `ARM64` label to run this workflow.
 
 For reference information, since ARM machines are not supported by GitHub-hosted runners, we use self-hosted runners prepared by the AWF.  
-Refer to [GitHub Docs](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) for the details about self-hosted runners.
+For the details about self-hosted runners, refer to [GitHub Docs](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners).
 
 ### deploy-docs
 

docs/contributing/pull-request-guidelines/review-tips.md

@@ -1,12 +1,10 @@
-# Tips
-
-This page introduces tips around pull requests or reviews.
+# Review tips
 
 ## Toggle annotations or review comments in the diff view
 
-There will be some annotations or review comments in the diff view during your review.
+There might be some annotations or review comments in the diff view during your review.
 
-Press the `A` key to toggle annotations.
+To toggle annotations, press the `A` key.
 
 Before:
 
@@ -16,16 +14,16 @@ After:
 
 ![after-press-a](images/after-press-a.png)
 
-Also, press the `I` key to toggle review comments.
+To toggle review comments, press the `I` key.
 
-Refer to [GitHub Docs](https://docs.github.com/en/get-started/using-github/keyboard-shortcuts) for other keyboard shortcuts.
+For other keyboard shortcuts, refer to [GitHub Docs](https://docs.github.com/en/get-started/using-github/keyboard-shortcuts).
 
 ## View code in the web-based Visual Studio Code
 
 You can open `Visual Studio Code` from your browser to view code in a rich UI.
-Press the `.` key on any repository or pull request.
+To use it, press the `.` key on any repository or pull request.
 
-Refer to [github/dev](https://github.com/github/dev) for more detailed usage.
+For more detailed usage, refer to [github/dev](https://github.com/github/dev).
 
 ## Check out the branch of a pull request quickly
 

docs/design/autoware-concepts/index.md

@@ -18,7 +18,7 @@ The Universe modules are extensions to the Core module that can be provided by t
 
 ## Interface design
 
-The interface design is the most essential piece of the microautonomy architecture, which is classified into internal and external interfaces. The component interface is designed for the components in a Universe module to communicate with those in other modules, including the Core module, within Autoware internally. The AD(Autonomous Driving) API, on the other hand, is designed for the applications of Autoware to access the technology components in the Core and Universe modules of Autoware externally. Designing solid interfaces, the microautonomy architecture is made possible with our partners, and at the same time is made feasible for our partners.
+The interface design is the most essential piece of the microautonomy architecture, which is classified into internal and external interfaces. The component interface is designed for the components in a Universe module to communicate with those in other modules, including the Core module, within Autoware internally. The AD(Autonomous Driving) API, on the other hand, is designed for the applications of Autoware to access the technology components in the Core and Universe modules of Autoware externally. Designing solid interfaces, the microautonomy architecture is made possible with AWF's partners, and at the same time is made feasible for the partners.
 
 ## Challenges
 

docs/design/autoware-interfaces/components/planning.md

@@ -129,7 +129,7 @@ A sequence of space and velocity points to be followed by the controller.
 
 ### Vehicle Signal Commands
 
-Commands for various elements of the vehicle unrelated to motion. Sent to the Vehicle Interface. (See [autoware_auto_vehicle_msgs](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/tree/master/autoware_auto_vehicle_msgs/msg) for the definition.)
+Commands for various elements of the vehicle unrelated to motion. Sent to the Vehicle Interface. (For the definition, see [autoware_auto_vehicle_msgs](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/tree/master/autoware_auto_vehicle_msgs/msg).)
 
 - HandBrake Command
 - Hazard Lights Command

docs/how-to-guides/advanced-usage-of-colcon.md

@@ -85,7 +85,7 @@ cat << EOS > ~/.colcon/defaults.yaml
 }
 ```
 
-See [here](https://colcon.readthedocs.io/en/released/user/configuration.html#defaults-yaml) for more details.
+For more details, see [here](https://colcon.readthedocs.io/en/released/user/configuration.html#defaults-yaml).
 
 ## Generating compile_commands.json
 
@@ -105,7 +105,7 @@ To see the compiler and linker invocations for a package, use `VERBOSE=1` and `-
 VERBOSE=1 colcon build --packages-up-to <package_name> --event-handlers console_cohesion+
 ```
 
-See [here](https://colcon.readthedocs.io/en/released/reference/event-handler-arguments.html) for other options.
+For other options, see [here](https://colcon.readthedocs.io/en/released/reference/event-handler-arguments.html).
 
 ## Using Ccache
 

docs/how-to-guides/how-to-integrate-autoware-with-your-vehicle.md

@@ -33,7 +33,7 @@ Use third-party tools such as [TIER IV's Vector Map Builder](https://tools.tier4
 
 Create your Autoware meta-repository.
 One easy way is to fork [autowarefoundation/autoware](https://github.com/autowarefoundation/autoware) and clone it.
-Refer to [GitHub Docs](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for how to fork a repository.
+For how to fork a repository, refer to [GitHub Docs](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
 
 ```bash
 git clone https://github.com/YOUR_NAME/autoware.git

docs/installation/additional-settings-for-developers/index.md

@@ -20,7 +20,7 @@ To customize it, write the following in your `.bashrc`:
 export RCUTILS_CONSOLE_OUTPUT_FORMAT="[{severity} {time}] [{name}]: {message} ({function_name}() at {file_name}:{line_number})"
 ```
 
-See [here](https://docs.ros.org/en/rolling/Tutorials/Logging-and-logger-configuration.html#console-output-formatting) for more options.
+For more options, see [here](https://docs.ros.org/en/rolling/Tutorials/Logging-and-logger-configuration.html#console-output-formatting).
 
 ### Enabling localhost-only communication
 
@@ -44,4 +44,4 @@ To avoid it, set a different domain ID for each group in your `.bashrc`:
 export ROS_DOMAIN_ID=X
 ```
 
-See [here](https://docs.ros.org/en/foxy/Concepts/About-Domain-ID.html#the-ros-domain-id) for more information.
+For more information, see [here](https://docs.ros.org/en/foxy/Concepts/About-Domain-ID.html#the-ros-domain-id).

docs/installation/autoware/docker-installation.md

@@ -62,7 +62,7 @@ You might need to log out and log back to make the current user able to use dock
 
      For detailed reason could be found [here](#docker-with-nvidia-gpu-fails-to-start-autoware-on-arm64-devices)
 
-   See [here](https://github.com/autowarefoundation/autoware/tree/main/docker/README.md) for more advanced usage.
+   For more advanced usage, see [here](https://github.com/autowarefoundation/autoware/tree/main/docker/README.md).
 
    After that, move to the workspace in the container:
 

docs/installation/autoware/source-installation.md

@@ -75,8 +75,8 @@ If you've manually installed the dependencies, you can skip this section.
 
 3. Build the workspace.
 
-   Autoware uses [colcon](https://colcon.readthedocs.io/en/released/index.html) to build workspaces.
-   Refer to the documentation for more advanced options.
+   Autoware uses [colcon](https://github.com/colcon) to build workspaces.
+   For more advanced options, refer to the [documentation](https://colcon.readthedocs.io/).
 
    ```bash
    colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
@@ -105,7 +105,7 @@ If you've manually installed the dependencies, you can skip this section.
    - `vcs pull` is similar to `git pull`.
      - Note that it doesn't switch branches.
 
-   Refer to the [official documentation](https://github.com/dirk-thomas/vcstool) for more information.
+   For more information, refer to the [official documentation](https://github.com/dirk-thomas/vcstool).
 
 3. Install dependent ROS packages.
 

docs/installation/index.md

@@ -16,7 +16,7 @@ The Autoware Foundation provides no support on other platforms than those listed
 - ROS 2 Galactic (**active development**)
 - ROS 2 Humble (**will be supported in 2022**)
 
-Refer to [REP-2000](https://www.ros.org/reps/rep-2000.html) for the system dependencies.
+For the system dependencies, refer to [REP-2000](https://www.ros.org/reps/rep-2000.html).
 
 ## Installing Autoware
 
@@ -29,25 +29,25 @@ If any issues occur during installation, refer to the [Support page](https://aut
 Docker can ensure that all developers in a project have a common, consistent development environment.
 It is recommended for beginners, casual users, people who are unfamiliar with Ubuntu.
 
-Refer to the [Docker installation guide](autoware/docker-installation.md) for detailed steps.
+For more information, refer to the [Docker installation guide](autoware/docker-installation.md).
 
 ### 2. Source installation
 
 Source installation is for the cases where more granular control of the installation environment is needed.
 It is recommended for experienced users or people who want to customize their environment.  
 Note that some problems may occur depending on your local environment.
 
-Refer to the [source installation guide](autoware/source-installation.md) for detailed steps.
+For more information, refer to the [source installation guide](autoware/source-installation.md).
 
 ## Installing related tools
 
 Some other tools are required depending on the evaluation you want to do.
 For example, to run an end-to-end simulation you need to install an appropriate simulator.
 
-See [here](related-tools) for how to install the tools.
+For more information, see [here](related-tools).
 
 ## Additional settings for developers
 
 There are also tools and settings for developers, such as Shells or IDEs.
 
-See [here](additional-settings-for-developers) for how to install the tools.
+For more information, see [here](additional-settings-for-developers).

docs/support/support-guidelines.md

@@ -29,7 +29,7 @@ Choose appropriate resources depending on what kind of help you need and read th
 Visit them and see if there is any information related to your problem.
 
 Note that the documentation sites aren't always up-to-date and perfect.
-If you find out that some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following our [contribution guidelines](../contributing/index.md).
+If you find out that some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following the [contribution guidelines](../contributing/index.md).
 
 !!! warning