Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning

https://minigrid.farama.org/

Other

2.13k stars 611 forks source link

Update WFCEnv documentation #438

Closed jysdoran closed 4 months ago

jysdoran commented 5 months ago

Description

Update documentation for WFCEnv. Also adjust title formatting of all env pages to handle class-style camelcase and be consistent with sidebar

Type of change

Please delete options that are not relevant.

[x] 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

Screenshots

Sidebar

old: new:

New WFC page

Renamed env pages

old: new:

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
[x] 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