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.

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

docs: update online doc with new environments #158

Conversation

clement-bonnet
Copy link
Collaborator

@clement-bonnet clement-bonnet commented Jun 4, 2023

fixes #155

  • add new environments to the online doc
  • update RobotWarehouse and Tetris PNGs and GIFs
  • display all 18 GIFs in the readme

@clement-bonnet clement-bonnet added the documentation Improvements or additions to documentation label Jun 4, 2023
@clement-bonnet clement-bonnet self-assigned this Jun 4, 2023
@clement-bonnet clement-bonnet linked an issue Jun 4, 2023 that may be closed by this pull request
…pdate-online-doc-with-new-environments

# Conflicts:
#	requirements/requirements.txt
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
djbyrne
djbyrne previously approved these changes Jun 5, 2023
@clement-bonnet
Copy link
Collaborator Author

Here is the current look of the readme
Screenshot from 2023-06-05 18-58-44

@TristanKalloniatis
Copy link
Contributor

Here is the current look of the readme Screenshot from 2023-06-05 18-58-44

Looks good, a couple quick questions:

  1. Some of the renderings look pretty similar, especially cleaner and maze. So in this view looks slightly odd IMO.
  2. I don't get the ordering in this collage

@TristanKalloniatis
Copy link
Contributor

TristanKalloniatis commented Jun 5, 2023

Is it purely alphabetical, ie not separated by env "type"? I ask because this is different from the order on the repo front page (in the table I mean)

@clement-bonnet
Copy link
Collaborator Author

Here is the current look of the readme Screenshot from 2023-06-05 18-58-44

Looks good, a couple quick questions:

  1. Some of the renderings look pretty similar, especially cleaner and maze. So in this view looks slightly odd IMO.
  2. I don't get the ordering in this collage
  1. Maze and Cleaner are under the hood using the same viewer abstraction, therefore they look similar indeed. I think it is even a good thing since you can show that things are easy to share. Either way, it is better to have all 18 environments that a selection that could make people think that only a few numbers of environments are implemented.
  2. Ordering is by alphabetic order (to mimic the paper).

Copy link
Contributor

@dluo96 dluo96 left a comment

Choose a reason for hiding this comment

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

LGTM!

@clement-bonnet clement-bonnet merged commit 737985e into instadeepai:main Jun 6, 2023
@clement-bonnet clement-bonnet deleted the 155-docs-update-online-doc-with-new-environments branch June 6, 2023 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: update online doc with new environments
4 participants