Skip to content

Commit

Permalink
Merge pull request #117 from mgoulao/patch-2
Browse files Browse the repository at this point in the history
Update docs/README.md to link to a new CONTRIBUTING.md for docs
  • Loading branch information
pseudo-rnd-thoughts committed Feb 20, 2023
2 parents 2aa5b45 + 8e53e0a commit 0a11cc9
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions 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

Expand Down Expand Up @@ -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
```

0 comments on commit 0a11cc9

Please sign in to comment.