Renamed sidebar headers and pages to be more consistent with other Farama projects.
Moved the "Development Environment" page to CONTRIBUTING.md, reusing content from other Farama projects.
Added a link to CONTRIBUTING.md in the "Getting Started" page.
In the documentation front page, replaced citation with a very simple reinforcement learning usage.
Also did the following changes:
Recovered the accidentally deleted "Basic Usage" page.
In the documentation front page, replaced the video with a gif (though I'm not sure if this is a good idea since it's 3MB). Also added a static screenshot of that video to README.md.
In the list of environments, regrouped the environments since (almost) all of them can now be solved with the new actions.
Type of change
Please delete options that are not relevant.
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update
Checklist:
[x] I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
Description
Addressed comments in Discord:
CONTRIBUTING.md, reusing content from other Farama projects.CONTRIBUTING.mdin the "Getting Started" page.Also did the following changes:
README.md.Type of change
Please delete options that are not relevant.
Checklist:
pre-commitchecks withpre-commit run --all-files(seeCONTRIBUTING.mdinstructions to set it up)