From 8e53e0ad8ad7678a69de16ae9318a48cd51a9ce8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20Goul=C3=A3o?= Date: Sun, 19 Feb 2023 11:45:07 +0000 Subject: [PATCH] Update README.md --- docs/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index ac558282..c99746ef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,10 @@ -# Gymnasium-Robotics-docs +# Gymnasium-Robotics docs -This repo contains the [NEW website]() for [Gymnasium-robotics](https://github.com/Farama-Foundation/Gymnasium-Robotics). This site is currently in Beta and we are in the process of adding/editing information. +This repo contains the documentation for [Gymnasium-Robotics](https://github.com/Farama-Foundation/Gymnasium-Robotics). -The documentation uses Sphinx. However, the documentation is written in regular md, NOT rst. - -If you are modifying a non-environment page or an atari environment page, please PR this repo. Otherwise, follow the steps below: +To modify an environment follow the steps below. For more information about how to contribute to the documentation go to our [CONTRIBUTING.md](https://github.com/Farama-Foundation/Celshast/blob/main/CONTRIBUTING.md) ## Instructions for modifying pages @@ -34,5 +32,5 @@ To rebuild the documentation automatically every time a change is made: ``` cd docs -sphinx-autobuild -b dirhtml ./source build/html +sphinx-autobuild -b dirhtml . _build ```