From eb4ae7ebe21a58a94f91cf38a7915cd8109096d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<fschroeder@techfak.uni-bielefeld.de>
Date: Tue, 5 Mar 2024 11:47:13 +0100
Subject: [PATCH] Update documentation and improve changelog
The provided modifications involve an update to the .gitlab-ci.yml file to include a footer text in the project documentation. There's also an additional point added to the CHANGELOG.md file under the 'study participants' section for clarity. Furthermore, the README.md has been slightly restructured to explicitly mention the availability of extensive project details in the documentation.
---
.gitlab-ci.yml | 2 +-
CHANGELOG.md | 1 +
README.md | 6 ++++--
3 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index e29c5778..c1c6015b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -18,7 +18,7 @@ pages:
- apt-get install -y python3-dev python3-pip graphviz graphviz-dev
- pip install pdoc
- pip install ".[rl]"
- - pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico footer-text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)"
+ - pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico --footer-text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)"
artifacts:
paths:
- public
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e6ffb898..54668c95 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -41,6 +41,7 @@ study server, 2D visualization, etc.
visualization, study
- Game server that handles active environments
- Study environment with study server and study config. Does the match making
+- For study participants: simple control tutorial, recipe guides, end screen.
- Controller support
### Security
diff --git a/README.md b/README.md
index 4573a845..ce6b0966 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,11 @@
# Cooperative Cuisine Environment
-[Documentation](https://scs.pages.ub.uni-bielefeld.de/cocosy/overcooked-simulator)
-
The overcooked-like cooperative cuisine environment for real-time human cooperative interactions and artificial agents.
+
+For an extensive introduction, have a look at
+the [Documentation](https://scs.pages.ub.uni-bielefeld.de/cocosy/overcooked-simulator).
+
<div align="center">
<img src="cooperative_cuisine/pygame_2d_vis/images/cooperative_cuisine.png" width="800">
</div>
--
GitLab