From 79fcf54e1e82ef871a2d1610dcd379680332a390 Mon Sep 17 00:00:00 2001 From: "Anssi \"Miffyli\" Kanervisto" Date: Thu, 15 Oct 2020 02:17:36 +0300 Subject: [PATCH] Review docs and update changelog --- docs/README.md | 4 ++-- docs/index.rst | 4 ---- docs/misc/changelog.rst | 2 ++ 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 1427a79..e75267f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -## Stable Baselines3 Documentation +## Stable Baselines3 Contrib Documentation -This folder contains documentation for the RL baselines. +This folder contains documentation for the RL baselines contribution repository. ### Build the Documentation diff --git a/docs/index.rst b/docs/index.rst index b77a85f..79c5f5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,10 +64,6 @@ To cite this project in publications: Contributing ------------ -To any interested in making the rl baselines better, there are still some improvements -that need to be done. -You can check issues in the `repo `_. - If you want to contribute, please read `CONTRIBUTING.md `_ first. Indices and tables diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 6cb9a38..db44b6d 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -24,6 +24,8 @@ Others: Documentation: ^^^^^^^^^^^^^^ +- Added initial documentation +- Added contribution guide and related PR templates Maintainers