-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce Featured Commands in README in scaffold package-readme #227
Comments
Thanks for the suggestion! I think listing all of the commands in a TOC could be a bit much for some. However, we could allow package authors curate the most popular commands into TOC (and indicate as such). |
In
Output would be: Example: https://github.com/ernilambar/database-command/tree/yo-toc#readme |
Cool, I think that looks reasonably good. |
Yah it seems there is already an issue: #141 |
@swissspidy That GitHub thingy of readme file looks cool. I didn't know that. Nice. |
@danielbachhuber Featured commands was sparked from the need to see all commands in a bird eye view, which GitHub kind of already provides (even though with one extra click). So I am now neutral about this now. I am ok whatever you decide. |
Yeah, let's wontfix this. I think it's only a problem when a package has a lot of commands, which is just a few. Package authors can easily highlight featured commands by creating a custom section part |
Feature Request
Describe your use case and the problem you are facing
For package with large number of commands and subcommands, navigating through commands is quite difficult. TOC in the beginning of readme would be very helpful.
Describe the solution you'd like
List the commands anchored with corresponding command.
Example: https://github.com/ernilambar/entity-command/blob/toc/README.md
The text was updated successfully, but these errors were encountered: