docs: Replace README with improved version #192
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Replace 1000+ line README with concise version - Add clear value proposition and 'Why NeMo Gym?' section - Include early development stage warning - Add product overview diagram - Reference new tutorial structure - Simplify quick start instructions - Add auto-generated resource servers table Old README content (how-tos, FAQs) will be migrated to: - Tutorials - CONTRIBUTING.md updates Related to #119 Signed-off-by: Chris Wing <cwing@nvidia.com>
Signed-off-by: Chris Wing <cwing@nvidia.com>
bxyu-nvidia
previously approved these changes
Oct 19, 2025
…eadme Signed-off-by: Brian Yu <bxyu@nvidia.com>
bxyu-nvidia
added a commit
that referenced
this pull request
Oct 21, 2025
## Description Replace 1000+ line README with streamlined < 100 line version for v0.1.0 release. Focus on quick start, clear value proposition, and appropriate expectations. ## What Changed - Added development stage warning - New production description and benefits section - Simplified quick start flow - Product overview diagram - Reduced from 1048 to 96 lines (-952 lines!) Old how-tos and FAQs will migrate to tutorials and CONTRIBUTING.md in separate PRs. Related to #119 --------- Signed-off-by: Chris Wing <cwing@nvidia.com> Signed-off-by: Brian Yu <bxyu@nvidia.com> Co-authored-by: Brian Yu <bxyu@nvidia.com> Signed-off-by: Brian Yu <bxyu@nvidia.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Replace 1000+ line README with streamlined < 100 line version for v0.1.0 release. Focus on quick start, clear value proposition, and appropriate expectations.
What Changed
Old how-tos and FAQs will migrate to tutorials and CONTRIBUTING.md in separate PRs.
Related to #119