humble docs

Author: voshch

README.md

@@ -1,4 +1,4 @@
-# Arena Rosnav Documentation
+# Arena 4.0 Documentation
 
 ## Installation
 
@@ -16,7 +16,7 @@ mkdocs serve
 
 ## Style Guide
 
-- The proper name of the project is Arena-Rosnav and should not be stylized.
+- The proper name of the project is Arena and should not be stylized.
 - Stylize other proper nouns and trademarks as _emphasized_ text.
 - Stylize paths, file names, and parameters as simple `quote blocks`.
 - Reference locations relative to their parent package when possible. Otherwise specify paths relative to the workspace root.

docs/contribute.md

@@ -6,30 +6,22 @@ Before making changes to the system, ensure that it is up-to-date by running
 rosrun arena_bringup pull
 ```
 
-which is a shortcut for
+### Adding Python Packages
 
+Add python packages to the environment by running 
 ```sh
-$(cd src/arena/arena-rosnav && git pull)
-vcs import src < src/arena/arena-rosnav/.repos
-rosdep update && rosdep install --from-paths src --ignore-src -r -y
-$(cd src/arena/arena-rosnav && poetry install)
+cd src/arena/arena-rosnav
+poetry add my_package
 ```
 
-
 ## Contributing to Arena-Rosnav/arena-rosnav
 
 Modifying the `arena-rosnav` repository is trivial.
 
-Commit your changes to the `arena-rosnav` repository. Push the changes to your fork and pull request the branch to `Arena-Rosnav:master`.
-
-## Contributing to Arena-Rosnav/*
-
-When modifying packages that are part of the `Arena-Rosnav` organization, but _not_ part of the main `arena-rosnav` repository; commit, push, and pull request the changes to the respective repositories.
-
-Once the pull requests are merged, update the commit hash in `src/arena/arena-rosnav/.repos` (use `rosrun arena_bringup repos` as an interactive tool). Finally, pull request the `.repos` change and provide a short description.
+Commit your changes to the `arena-rosnav` repository.
 
 ## Dependencies on External Tools
 
 If you need external packages that _aren't_ installable using `rosdep`, add the respective repository to `src/extern/`.
 
-Add the repository to `src/arena/arena-rosnav/.repos` (use `rosrun arena_bringup repos` as an interactive tool). Finally, pull request the `.repos` change and provide a short description.
+Add the repository to `src/arena/arena-rosnav/.repos/<package>.repos` (use `rosrun arena_bringup repos` as an interactive tool). Finally, pull request the `.repos` change and provide a short description.

docs/index.md

@@ -1,17 +1,17 @@
-# Welcome to the Arena Rosnav docs!
+# Welcome to the Arena 4.0 docs!
 
 [Arena Rosnav](https://github.com/Arena-Rosnav/arena-rosnav) is a set of tools for training and evaluating of navigational algorithms for obstacle avoidance. Arena Rosnav is modular and flexible and allows to easily integrate new environments and planners, as well as running existing planners and models in predefined benchmark scenarios and evaluating the performance with ease. Next to the planners and environments we offer a wide variety of different robots and worlds for your use.
 
-Arena Rosnav offers a complete evaluation pipeline for benchmarking the performance of robots and planners based on standard metrics, and a trainings pipeline for navigational models based on DRL and PPO. With this pipeline our own DRL planner [ROSNavRL](packages/rosnavrl.md) was created.
+Arena Rosnav offers a complete evaluation pipeline for benchmarking the performance of robots and planners based on standard metrics, and a trainings pipeline for navigational models based on DRL and PPO. With this pipeline our own DRL planner ROSNavRL was created.
 
 ## Features
 
 <!-- - Integration of [Flatland](https://flatland-simulator.readthedocs.io/en/latest/) to train new agents and [Flatland](https://flatland-simulator.readthedocs.io/en/latest/) and [Gazebo](https://classic.gazebosim.org/) for evaluating existing approaches. -->
 - Variety of planners, robots and worlds
 - Pipeline to train planner agents based on reinforcement learning approaches from [stable baselines3](https://github.com/DLR-RM/stable-baselines3.git)
-- [Task generator](packages/task_generator.md) for managing highly dynamic and custom environments
-- Our own DRL planner [ROSNavRL](packages/rosnavrl.md)
-- Pipeline for evaluating approaches and analysing them based on standard metrics with our [Evaluation](packages/arena_evaluation.md) package.
+- Task Generator for managing highly dynamic and custom environments
+- Our own DRL planner ROSNavRL.
+- Pipeline for evaluating approaches and analysing them based on standard metrics with our Evaluation package.
 - Modular structure for extension of new functionalities and approaches
 - Evaluation of multiple robots and planners in the same simulation
 - Dynamic rviz config file creation for visualization
@@ -89,7 +89,7 @@ Arena Rosnav offers a complete evaluation pipeline for benchmarking the performa
 
 
 
-
+<!-- 
 ### Planners
 
 Planners are essential packages and control the robot, which is simulated in the environments.
@@ -144,11 +144,11 @@ For training:
 For evaluation:
 
 - [Flatland](https://flatland-simulator.readthedocs.io/en/latest/index.html)
-- [Gazebo](https://classic.gazebosim.org/)
+- [Gazebo](https://classic.gazebosim.org/) -->
 
 ### Evaluation
 
-To benchmark the performance of your simulation and visualize your results with qualitative and quantitative plots like in the example below, see the documentation [here](packages/arena_evaluation.md)
+To benchmark the performance of your simulation and visualize your results with qualitative and quantitative plots like in the example below, use Arena-Evaluation.
 
 | <img width="600" height=350 src="images/qualitative_plot.png"> | <img width="650" height=350 src="images/quantitativ_plots.png"> |
 | :------------------------------------------------------------: | :-------------------------------------------------------------: |