Skip to content

feat(docs): Create community datasets docs page#314

Merged
younik merged 11 commits intoFarama-Foundation:mainfrom
rob-pitkin:f/create-community-datasets-docs
Jan 10, 2026
Merged

feat(docs): Create community datasets docs page#314
younik merged 11 commits intoFarama-Foundation:mainfrom
rob-pitkin:f/create-community-datasets-docs

Conversation

@rob-pitkin
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Creates the community datasets page in the docs website. Requires adding PyYAML as a requirement.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.
To upload images to a PR -- simply drag and drop or copy paste.

Screenshot 2025-10-11 at 2 01 54 PM

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • 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

Copy link
Member

@younik younik left a comment

Choose a reason for hiding this comment

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

Thanks for this, it looks good!

One important change: we should also generate the dataset page, and clicking on the card should open it (instead of the hugging face link as it is now).

You can reuse the function in this file:

https://github.com/Farama-Foundation/Minari/blob/main/docs/_scripts/gen_dataset_md.py

Comment on lines 61 to 63

content += ".. raw:: html\n\n"
content += " </div>\n\n"
Copy link
Member

Choose a reason for hiding this comment

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

it would be nice to add an extra "card", saying "Add your dataset here", that, if clicked, will point you to the README to add the dataset

@rob-pitkin rob-pitkin requested a review from younik October 20, 2025 05:15
Comment on lines 39 to 44
description = metadata.get("description", "")

# Generate page content with custom title
content = "---\nautogenerated:\n"
content += f"title: {display_name}\n"
content += "---\n\n"
Copy link
Member

Choose a reason for hiding this comment

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

and finally, from here to bottom, I think we should reuse the code in gen_dataset_md so dataset groups (even if nested) are handled correctly. You may need to refactor main() to use a customizable remote entry point, like hf://user/dataset instead of using our remote_datasets

@younik younik marked this pull request as ready for review January 10, 2026 15:38
@younik younik merged commit 89f19cd into Farama-Foundation:main Jan 10, 2026
4 checks passed
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