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

README TODO #85

Closed
7 tasks done
whitead opened this issue Oct 25, 2024 · 0 comments · Fixed by #88
Closed
7 tasks done

README TODO #85

whitead opened this issue Oct 25, 2024 · 0 comments · Fixed by #88
Assignees
@jamesbraza
Labels
documentation Improvements or additions to documentation

Comments

@whitead
Copy link
Contributor

whitead commented Oct 25, 2024 •
edited
Loading

  • Messages - rewrite this section to be about env/agent
  • Move API keys to developer section (since they're discussed in the context of unit tests)
  • Check async vs sync. Things like reset are async now, I think
  • export_frame - let's not make this abstract; no one uses it
  • Move README for individual environments to their subdirectories; in the main README, just provide a one-sentence overview, install command, and link to the README
  • [?] Can we hide type hinting from the examples? It would reduce clutter and information density. We can just mention in a section that the library is fully typed
  • Add Jupyter Notebook/Colab notebook section - include Python 3.11 install and note that async can be used in notebooks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jamesbraza jamesbraza

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

README.md badges, installation, CONTRIBUTING.md, blacken-docs Future-House/aviary
2 participants
@whitead @jamesbraza