Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated documentations in docs/ #31

Merged
merged 1 commit into from
Mar 13, 2023
Merged

Updated documentations in docs/ #31

merged 1 commit into from
Mar 13, 2023

Conversation

ppasupat
Copy link
Collaborator

@ppasupat ppasupat commented Mar 13, 2023 •
edited
Loading

Description

Updated the documentation in docs/.

  • The content was mostly lifted from README.
  • Added example code usage which was lifted from the tests.
  • Added a video from the defunct site of OpenAI MiniWoB.

Some sections are still missing, mainly the observation and action spaces.

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)
  • This change requires a documentation update

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@ppasupat ppasupat marked this pull request as ready for review March 13, 2023 11:52
pseudo-rnd-thoughts
pseudo-rnd-thoughts approved these changes Mar 13, 2023
View reviewed changes
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, do we have a website url to link to?
If so, we need to update https://farama.org/projects and link on the readme

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 6b41cc1 into Farama-Foundation:master Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pseudo-rnd-thoughts pseudo-rnd-thoughts pseudo-rnd-thoughts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ppasupat @pseudo-rnd-thoughts