Farama-Foundation/gym-docs

[Proposal] Proper documentation versioning

trigaten opened this issue · 4 comments

BlueskyFR commented

Hi! Thanks for opening this issue. I think this should get a much higher priority since almost all users are currently unable to read a documentation matching the version they use.
Keeping the documentation that way encourages everyone to install the latest master version, which is really unsafe/unstable/not recommended for end users.

RedTachyon commented

For the record, I have a proof of concept for this.
main page - https://gym-docs.readthedocs.io/
The version switching shindig is at the bottom left
I changed one file, so version from master: https://gym-docs.readthedocs.io/en/latest/content/environment_creation.html
Modified version: https://gym-docs.readthedocs.io/en/feature-branch/content/environment_creation.html

It would require switching from GH Pages to ReadTheDocs, which is a pretty widely used tool

Markus28 commented

I think this is somewhat related to this topic: Imo we should remove the auto-generated environment pages from the repository and build them in CI/ on RTD. Nobody seems to bother to manually rebuild the markdown files, which are quite outdated at the moment. It will be virtually impossible to keep everything in sync with the Gym repo by hand.

  • 👍1