diff --git a/README.md b/README.md index 3ab6d5d76896dea83eae1b5aace886cab10a8597..7bf6244c234e4e82ff534d67ac6d0dda2b7b56a9 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,17 @@ ROS2 Navigation System # Overview The ROS 2 Navigation System is the control system that enables a robot to autonomously reach a goal state, such as a specific position and orientation relative to a specific map. Given a current pose, a map, and a goal, such as a destination pose, the navigation system generates a plan to reach the goal, and outputs commands to autonomously drive the robot, respecting any safety constraints and avoiding obstacles encountered along the way. +# Documentation +For detailed instructions on how to install and run the examples, please visit our [documentation site](https://ros-planning.github.io/navigation2/). + # Contributing -We are currently in the pre-release development phase, contributions are welcome. To contribute, see the [documentation README](doc/README.md). +[Contributions are welcome!](doc/README.md#contributing). For more information, please review our [contribution guidelines](https://ros-planning.github.io/navigation2/contribute/contribute_guidelines.html). # Building the source For instructions on how to download and build this repo, see the [BUILD.md](doc/BUILD.md) file. # Creating a docker image -To build an image from the Dockerfile in the navigation2 folder: +To build an image from the Dockerfile in the navigation2 folder: First, clone the repo to your local system (or see Building the source above) ``` sudo docker build -t nav2/latest . diff --git a/sphinx_doc/README.md b/sphinx_doc/README.md index 09c2c178b8ef6c8d8b9245c2f9c1000e2999b1f4..ff7c1c80994143f9c58dbb7f69d673abafdb0504 100644 --- a/sphinx_doc/README.md +++ b/sphinx_doc/README.md @@ -1,6 +1,6 @@ -# Project Documentation +# Navigation2 Documentation This folder holds the source and configuration files used to generate the -Project documentation web site. +[Navigation2 documentation](https://ros-planning.github.io/navigation2/) web site. -Learn how to setup and generate documentation by reading the howtos +Learn how to setup and generate documentation by reading the [howtos](https://ros-planning.github.io/navigation2/howtos/index.html).