Skip to content

docs: add "What's Hot" section to README#1992

Open
lbliii wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/readme-whats-new-section
Open

docs: add "What's Hot" section to README#1992
lbliii wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/readme-whats-new-section

Conversation

@lbliii
Copy link
Copy Markdown
Contributor

@lbliii lbliii commented May 15, 2026

Summary

  • Adds a "What's Hot" section to the top of the README highlighting Slurm deployment, Audio curation, and the Inference Server
  • Sits above the existing "Updates" release log so feature highlights and release history serve distinct purposes
  • Addresses #1552 (better surfacing of new features on the landing page)

Context

Requested by Arham in #docs Slack thread — developers landing on the README should immediately see the latest capabilities worth trying. The three highlighted features were called out by Arham; cc @nemo-curator-leads if anything else should be added before merge (candidates: Cosmos-Embed1 video embeddings, Nemotron-CC recipe, simplified Resources API).

Test plan

  • Preview README rendering on GitHub
  • Verify all three doc links resolve
  • Confirm leads are aligned on the three highlighted features

🤖 Generated with Claude Code

@lbliii lbliii requested a review from a team as a code owner May 15, 2026 17:52
@lbliii lbliii requested review from VibhuJawa and removed request for a team May 15, 2026 17:52
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 15, 2026

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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 15, 2026

Greptile Summary

This PR adds a new "What's Hot" section near the top of the README to surface recently shipped capabilities that developers should know about on first landing. The section uses the same Markdown table style already present elsewhere in the file and sits above the existing "Updates" release log.

  • Adds a three-row feature table with display names, one-line value props, and links to the NeMo Curator docs for Slurm deployment, Audio curation, and the Inference Server.
  • Appends a blockquote callout inviting contributors to suggest additions; @nemo-curator-leads is correctly wrapped in backticks so GitHub does not interpret it as a user mention.

Confidence Score: 5/5

Documentation-only change with no code or configuration touched — safe to merge.

The change adds a small Markdown table and a blockquote to the README. Nothing executable is modified, the new links point to the same docs domain already used throughout the file, and the @nemo-curator-leads handle is correctly escaped with backticks so it won't fire a GitHub notification.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds a "What's Hot" table section above the existing Updates log, featuring three doc links for Slurm deployment, Audio curation, and Inference Server — purely editorial, no code changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README top] --> B[Badges & Title]
    B --> C["**NEW** What's Hot table\n(Slurm · Audio · Inference Server)"]
    C --> D[Updates release log]
    D --> E[What You Can Do table]
    E --> F[Quick Start]
    F --> G[Architecture & further sections]
Loading

Reviews (2): Last reviewed commit: "docs: add "What's Hot" section to README" | Re-trigger Greptile

@lbliii lbliii requested a review from arhamm1 May 15, 2026 18:17
Surfaces the latest capabilities developers should know about — Slurm,
Audio, and Inference Server — at the top of the README. Addresses NVIDIA-NeMo#1552.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii lbliii force-pushed the lbliii/readme-whats-new-section branch from b03bfbd to 32f6c6b Compare May 15, 2026 19:03
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.

1 participant