planning folder on top

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
zulfaqar-azmi-t4 · Nov 28, 2023 · 6bf19b6 · 6bf19b6
1 parent feecf92
commit 6bf19b6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/planning/.pages b/planning/.pages
@@ -1,5 +1,5 @@
 nav:
-  - 'https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/components/planning/'
+  - planning
   - 'Behavior Path Planner':
     - 'About Behavior Path': planning/behavior_path_planner
     - 'Concept':

diff --git a/planning/README.md b/planning/README.md
@@ -0,0 +1,7 @@
+# Planning Components
+
+The Autoware.Universe Planning Modules represent a cutting-edge component within the broader open-source autonomous driving software stack. These modules play a pivotal role in autonomous vehicle navigation, skillfully handling route planning, dynamic obstacle avoidance, and real-time adaptation to varied traffic conditions.
+
+- For high level concept of Planning Components, please refer to [Planning Component Design Document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/planning/)
+- To understand how Planning Components interacts with other components, please refer to [Planning Component Interface Document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/components/planning/)
+- The [Node Diagram](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/node-diagram/) illustrates the interactions, inputs, and outputs of all modules in the Autoware.Universe, including planning modules.