docs: polish README first screen + repo metadata for discoverability - #8
Merged
Conversation
Rewrite the top of the README (above Project Structure) to give the project a stronger first impression for visitors arriving from search / social / awesome-lists: - Title + one-line tagline with SEO keywords (NVLink, GPU, bandwidth, NVIDIA, multi-GPU, LLM/HPC clusters). - Badges: CI, MIT license, stars, platform — signals the project is alive and legit. - A 'Why?' block positioning against nvidia-smi (no per-link NVLink throughput) and dcgmi (heavyweight), framing the pain point. - A concise Features list highlighting the differentiators added recently (bidir full-duplex, all-pairs sweep, CSV/JSON, GPU filter, 81 tests). - A Demo block with real output from an 8x H20 run (verbose monitor, bidir 730 GiB/s, all-pairs summary) plus a note inviting a terminal recording. - A 3-line Quick start (install-deps, make monitor, run) so visitors can try in seconds. Removed the now-redundant later '## Features' section (its content is covered and improved by the new first-screen list and the per-tool Usage sections). Repo metadata (description + 12 topics) set separately via gh repo edit so the project shows up in GitHub topic/search pages. Signed-off-by: staryxchen <staryxchen@tencent.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Polish the README first screen and repo metadata to improve discoverability and visitor→star conversion. First step of the "get more stars" plan — the README is the landing page for every distribution channel (HN, Reddit, awesome-lists, search).
Repo metadata (set directly via
gh repo edit, already live)Real-time per-link NVLink bandwidth monitor + inter-GPU P2P benchmark for NVIDIA multi-GPU systems. Lightweight C++ — the monitor needs no CUDA toolkit.nvidia,nvlink,gpu,cuda,nvml,monitoring,bandwidth,hpc,gpu-monitoring,llm-training,p2p,benchmarkThe repo previously had no topics (invisible to GitHub topic/search pages) and a generic description.
README first screen (
README.md)Replaced the thin title + 2-bullet intro with a conversion-oriented landing:
nvidia-smi(no per-link NVLink throughput) anddcgmi(heavyweight) — states the pain point.Also removed the now-redundant later
## Featuressection (covered and improved by the new first-screen list + per-tool Usage sections).Verification
Doc-only change — not in
clang-formator test scope.make check-format/make testunaffected (source files untouched). README rendered/previewed locally.Files changed
Next (optional, follow-up)