Skip to content

docs: site config, about section#257

Closed
lbliii wants to merge 41 commits intomainfrom
llane/site-config-and-about-section
Closed

docs: site config, about section#257
lbliii wants to merge 41 commits intomainfrom
llane/site-config-and-about-section

Conversation

@lbliii
Copy link
Copy Markdown
Contributor

@lbliii lbliii commented Oct 30, 2025

This is the initial PR for:

  • updating site config with sphinx requirements
  • updating docs commands via makefile shortcuts
  • adding an About/ section
  • beginning updates to the site home page (links to about items)
  • minor cleanup of tutorials now that we have concept pages (further work will be done here in the next PR for Getting Gtarted)
  • moved terminology to a resource page

All feedback is welcome, please fine-tune the language/sections as desired.

you can quickly deploy local preview of the docs by running:

cd docs
make docs-live

@lbliii lbliii self-assigned this Oct 30, 2025
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Oct 30, 2025

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@lbliii lbliii added the documentation Improvements to documentation label Oct 30, 2025
@lbliii lbliii added this to the v0.1.0 milestone Oct 30, 2025
@lbliii lbliii force-pushed the llane/site-config-and-about-section branch from 1bccdd8 to d716708 Compare November 3, 2025 16:21
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Nov 3, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@lbliii lbliii force-pushed the llane/site-config-and-about-section branch 7 times, most recently from 26cbc44 to fc0d719 Compare November 3, 2025 16:38
@lbliii lbliii marked this pull request as ready for review November 3, 2025 16:47
@lbliii lbliii requested a review from a team as a code owner November 3, 2025 16:47
@lbliii lbliii mentioned this pull request Nov 3, 2025
Copy link
Copy Markdown
Contributor

@heatherlxd heatherlxd left a comment

Choose a reason for hiding this comment

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

After this read through I recommend we change the IA to be more onboarding focused to:

Overview
Concepts
Architecture
Ecosystem
Key Features
Release Notes
This order builds in complexity and understanding across the entire about section reading and ends with the more abstract.

I also noticed we change the order between how we talk about Agents, Models, and Resources - this happens between pages, tabs, and even sentences. We should have a consistent way to introduce this trio and make it consistent to build the mental model. While concepts starts with models I wonder if we should start with Agent since all the example sequences start with the agent? Leave order choice to the team but would recommend that the trio follows the same pattern and aligns to how they work together when possible.

Other suggestions in-line

Comment thread docs/resources/index.md Outdated
Comment thread docs/about/glossary.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A general overall comment would be if we want to keep this order for the glossary. It is helpful to have these terms organized by category - I'm just not certain if those categories are in the ideal order? This may be a workflow question - align with when you encounter in E2E workflow or decision points.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit Should orchestrates be capitalized?

Comment thread docs/index.md Outdated
Comment thread docs/about/index.md Outdated
Comment thread docs/about/concepts/core-abstractions.md Outdated
Comment thread docs/about/concepts/rollout-collection-fundamentals.md Outdated
Comment thread docs/about/concepts/verifying-agent-results.md Outdated
Comment thread docs/about/concepts/verifying-agent-results.md Outdated
Comment thread docs/about/concepts/verifying-agent-results.md Outdated
@lbliii lbliii force-pushed the llane/site-config-and-about-section branch 2 times, most recently from 93aa6a5 to a079197 Compare November 10, 2025 14:44
Comment thread docs/about/index.md Outdated
Comment thread docs/about/index.md Outdated

## The Challenge: Scaling RL Training Data

Training AI agents through reinforcement learning requires massive amounts of high-quality interaction data. Teams face several obstacles:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

better to explain interaction data before this

Comment thread docs/about/index.md Outdated
Comment thread docs/about/index.md Outdated
Comment thread docs/about/index.md Outdated
Comment thread docs/resources/index.md Outdated
@lbliii
Copy link
Copy Markdown
Contributor Author

lbliii commented Nov 12, 2025

@cwing-nvidia @bxyu-nvidia could we get approval for merge? we can continue to make changes after

…e glossary from resources; update all cross-references

Signed-off-by: Lawrence Lane <llane@nvidia.com>
…erability; update concepts/index to single-page format

Signed-off-by: Lawrence Lane <llane@nvidia.com>
…e; strengthen opening value props with explicit answers to 'what/why/for'

Signed-off-by: Lawrence Lane <llane@nvidia.com>
…ts, collapsible sections, and concise language

Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
…ediate audience; remove basic explanations, tighten prose, focus on NeMo Gym-specific patterns

Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
bxyu-nvidia added a commit that referenced this pull request Nov 14, 2025
Credit to @lbliii and see #257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
bxyu-nvidia added a commit that referenced this pull request Nov 14, 2025
)

Credit to @lbliii and see #257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
bxyu-nvidia added a commit that referenced this pull request Nov 14, 2025
Credit to @lbliii and see #257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
@cwing-nvidia cwing-nvidia removed this from the v0.1.0 milestone Nov 21, 2025
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Kelvin0110 pushed a commit to Kelvin0110/Gym that referenced this pull request Feb 16, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
Kelvin0110 pushed a commit to Kelvin0110/Gym that referenced this pull request Feb 16, 2026
Kelvin0110 pushed a commit to Kelvin0110/Gym that referenced this pull request Feb 16, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
…VIDIA-NeMo#322)

Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
…VIDIA-NeMo#322)

Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
abubakaria56 pushed a commit to abubakaria56/Gym that referenced this pull request Mar 2, 2026
Credit to @lbliii and see NVIDIA-NeMo#257

---------

Signed-off-by: Brian Yu <bxyu@nvidia.com>
@bxyu-nvidia bxyu-nvidia deleted the llane/site-config-and-about-section branch March 26, 2026 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants