Repository navigation
📚 docs: readme: open with an image, a pitch, the install, and an example - #513
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the
|
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
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.
Outside the plan: a README change Pascal asked for.
Problem
The top of the README did not tell a stranger what Nicely is or how to try it. It opened with one dense sentence and a list of commands, with no image, and the install steps came far below.
Solution
docs/assets/hero.png(1280x640) and show it first, with alt textncly skill list, with its real outputncly skill listfrom the command list below it, because the example now shows it. The rest of the README does not changeProof:
ncly skill list(v0.27.0, empty HOME) prints the four bundled skillsnicely,nicely-auth,nicely-extensions,nicely-runsand exits 0, which is the output the README shows.by Opus-5.5 via Claude Code