search

Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning
https://minigrid.farama.org/
Other
2.09k stars 604 forks source link

[Proposal] Update documentation #412

Closed JupiLogy closed 8 months ago

JupiLogy commented 8 months ago

Proposal

The documentation on minigrid.farama.org/ has not been updated in a while.

Motivation

I made an update to all the files to link to the correct code location a while ago. However, the actual documentation on minigrid.farama.org/ has not been updated. Additionally, some functions that have been integrated more recently are not found on the minigrid.farama.org website, such as RGB partial image obs wrapper in wrapper.py.

Pitch

Update minigrid.farama.org

Alternatives

Additional context

Checklist

pseudo-rnd-thoughts commented 8 months ago

Thanks @JupiLogy for noticing, as the website uses version control then it is not updated until we make a new release.

@BolunDai0216 It looks like the website CI is failing, do you have time to look into it? Then we really need to make a new version release

BolunDai0216 commented 8 months ago

@JupiLogy Do you the time to do a PR for wrappers.md with the up-to-date wrappers?

If not, I can do it tonight.

JupiLogy commented 8 months ago

On it :)