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

Ad/documentation #272

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Ad/documentation #272

merged 3 commits into from
Jan 29, 2024

Conversation

anishhdiwan
Copy link
Contributor

Added an explanation of some core classes from rl_games and how they work. Also added a guide on using rl_games for your own work (using a style similar to IsaacGymEnvs).

@Denys88 I hope this is accurate and helps others easily adapt rl_games to their own work :)

@Denys88
Copy link
Owner

Denys88 commented Jan 26, 2024

Reviewing it!

@anishhdiwan
Copy link
Contributor Author

Hey! I'm closing the PR temporarily. I realise that a how-to might not be relevant as "documentation" for the library. I'll try and add some docstrings to the essential parts of the library so that a proper documentation can be made with tools like Sphinx. Let me know if you have any feedback!

@Denys88
Copy link
Owner

Denys88 commented Jan 28, 2024

Hi @anishhdiwan, it looks good overall. And everything is done in separate in separate doc.
Actually I am happy to merge it as is right now, just need to add a link to the top of README.md.
In a few weeks I can make next release.

@anishhdiwan
Copy link
Contributor Author

Hello @Denys88, that sounds great! I can reopen the PR then. Could you please add the README link (not sure where it'd fit the best)?

I will also add the docstrings soon and send another PR at a later time. Thanks

@anishhdiwan anishhdiwan reopened this Jan 29, 2024
@Denys88
Copy link
Owner

Denys88 commented Jan 29, 2024

Will do it.
Could you confirm your name please: Anish Diwan? I want to put it near the link or in your doc (up to you), thanks.

@anishhdiwan
Copy link
Contributor Author

Yep, its Anish Diwan. I just added it to the doc. Thanks

@Denys88 Denys88 merged commit 165652c into Denys88:master Jan 29, 2024
krishpop pushed a commit to krishpop/rl_games that referenced this pull request Sep 11, 2024
* Add docs

* Update docs; Rename file

* Add author

---------

Co-authored-by: anishdiwan <anishdiwan@diwan-ubuntu20.04>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants