Farama-Foundation / miniwob-plusplus

MiniWoB++: a web interaction benchmark for reinforcement learning
https://miniwob.farama.org/
MIT License
280 stars 47 forks source link

Added documentation for environments. #22

Closed ppasupat closed 1 year ago

ppasupat commented 1 year ago

Description

This PR depends on PR #21.

Type of change

Please delete options that are not relevant.

Checklist:

mgoulao commented 1 year ago

@ppasupat add a workflow like this https://github.com/Farama-Foundation/Gymnasium/blob/main/.github/workflows/build-docs.yml, you need to change some parts, like "Install Gymnasium" or "Install dependencies" . Generated files should be ignored by git, so I would suggest you remove all Markdown files that are generated using gen_md.py and add a line to the .gitignore with something like docs/environments/miniwob/*.md.

ppasupat commented 1 year ago

I added build-docs.yml and the files it mentions. I also added .gitignore.