Skip to content

docs: improve README header with badges and fix ip install typo#500

Merged
ko3n1g merged 1 commit intomainfrom
ko3n1g/docs/improve-readme
Apr 23, 2026
Merged

docs: improve README header with badges and fix ip install typo#500
ko3n1g merged 1 commit intomainfrom
ko3n1g/docs/improve-readme

Conversation

@ko3n1g
Copy link
Copy Markdown
Contributor

@ko3n1g ko3n1g commented Apr 23, 2026

Claude summary

Summary

  • Adds a centered <div align="center"> header to README.md matching the style of other NeMo repos (Megatron-Bridge), with four badges (Codecov, CI/CD, Python 3.10+, GitHub Stars) and navigation quick-links (Documentation · Examples · Contributing · FAQs)
  • Removes the redundant embedded table of contents
  • Minor cleanup: drops noisy inline comment # Local executor, removes trailing periods from tutorial links, promotes #### Hello world to ### Hello world for consistent heading hierarchy, renames "Contribute to NeMo Run" → "Contributing"
  • Fixes a ip installpip install typo in docs/index.md

Example header

Test plan

  • README renders correctly on GitHub (badges resolve, nav links work)
  • docs/index.md install command correct

Signed-off-by: oliver könig <okoenig@nvidia.com>
@ko3n1g ko3n1g merged commit c2b4b98 into main Apr 23, 2026
24 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