Skip to content

Improve README quickstart readability and command discoverability - #55

Merged
mosheabr merged 8 commits into
NVIDIA:mainfrom
swaminator:main
May 14, 2026
Merged

Improve README quickstart readability and command discoverability#55
mosheabr merged 8 commits into
NVIDIA:mainfrom
swaminator:main

Conversation

@swaminator

Copy link
Copy Markdown
Contributor

Summary

  • Pruned the README intro so the repository purpose and Quickstart appear sooner.

  • Made the default install flow the first and most prominent Quickstart command:

    npx skills add nvidia/skills
  • Reorganized secondary install paths under Quickstart:

    • one-skill installs without prompts
    • agent-specific installs
    • multi-agent installs
    • catalog browsing
  • Split commands into copyable fenced blocks.

  • Added common agent callouts for Claude Code, Codex, Cursor, and Kiro.

  • Linked to the upstream skills CLI supported agents table.

  • Renamed Available Skills to Skill Catalog.

  • Linked Quickstart guidance directly to the Skill Catalog.

  • Updated the intro to note that NVIDIA skills are available publicly and that the catalog is being built in the open, with a Roadmap link.

Validation

  • Ran git diff --check.
  • Markdown-only README changes; no runtime tests needed.

@mosheabr mosheabr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Solid restructure — the Quickstart-first / default-install-first ordering is the right call, and the agent-specific blocks for Claude Code / Codex / Cursor / Kiro give new users exactly the copy-pasteables they need. Section rename to "Skill Catalog" reads better too.

A few items before merge:

DCO sign-off (blocker)

The 7 commits don't have Signed-off-by: trailers, so the DCO check (#38) will fail. Quick fix:

git rebase --signoff origin/main && git push --force-with-lease

This rewrites the existing commits with sign-offs without changing content. Author affiliation check is fine — all 7 commits are from nswami@nvidia.com.

Catalog-framing content removed

The three intro paragraphs that explained "this repository is a catalog — skills are maintained in their respective product repos and mirrored here daily via an automated sync pipeline" and the "building in the open" framing got compressed to one line. The agentskills.io spec reference is preserved later in the file, but the "this is a catalog, not a source-of-truth" framing is now absent. That framing matters for product teams browsing — it sets expectations that they don't edit content here, they edit in their own repo and the catalog mirrors.

Two options to preserve it without bloating the intro:

  1. Restore one short sentence in the intro about the catalog model, or
  2. Add a small "About this catalog" subsection between Quickstart and Skill Catalog explaining the mirror model.

I'd lean toward (1) since the intro is otherwise tight. Suggested sentence: "This repository is a catalog — skills are maintained in their respective product repos and mirrored here daily via an automated sync pipeline."

Branch name

Looks like this PR is from main on your fork rather than a feature branch. Not technically wrong, just unusual. Worth confirming this is intended so the branch doesn't accidentally collide with upstream sync work later.

Otherwise good to go once DCO is fixed and the catalog-framing sentence is back in.

Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
Signed-off-by: Nikhil Swaminathan <nswami@nvidia.com>
@swaminator

Copy link
Copy Markdown
Contributor Author

Addressed the review feedback:\n\n- Restored the catalog/mirroring framing in the intro: skills are maintained in product repos and mirrored here daily.\n- Rebased the PR branch with DCO sign-offs on all commits.\n- Keeping the PR on the fork main branch for this change; noted that it is unusual but intentional for this PR.\n\nLocal validation: git diff --check upstream/main..HEAD passes.

@mosheabr mosheabr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approve. Catalog-framing sentence restored cleanly, DCO clean on all 8 commits. Ready to merge.

@mosheabr
mosheabr merged commit 978902c into NVIDIA:main May 14, 2026
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