simple_weather example README is empty

Open
#227 0 comments 0 reactions 1 assignee View on GitHub

@bxyu-nvidia is already working on this.

Since Oct 30, 2025.

Assessment

This issue has not been assessed yet.

Description

documentation env-infra
Problem

The resources_servers/simple_weather/README.md is essentially empty (only licensing info). This is particularly problematic because simple_weather is the primary introductory example featured in:

  • Main repository README
  • Tutorial 01 (Concepts)
  • Tutorial 02 (Setup - first hands-on example)

Users following the tutorials who navigate to the resource server directory find no documentation.

Current State
  • No description of the example
  • No usage commands
  • No example output
Expected Content

As the primary example resource server, the README should include:

  1. Overview: What this example demonstrates
  2. Learning Goals: What users should learn from this example
  3. Usage Commands: How to run the server and collect example rollouts
  4. Example Output: Sample prompts and agent behavior
Impact

Since simple_weather is featured in tutorials as the first hands-on example, the empty README creates a poor first impression and leaves new users without reference documentation.

Dominant language
Python
Stars
1.2k
Forks
349
Avg merge
1d 21h
Merged PRs (30d)
318

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NVIDIA-NeMo/Gym

All issues in NVIDIA-NeMo/Gym

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.