Skip to content
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

Provide a description of plugins in the list #59

Closed
mcornella opened this issue Aug 7, 2024 · 1 comment
Closed

Provide a description of plugins in the list #59

mcornella opened this issue Aug 7, 2024 · 1 comment
Assignees

Comments

@mcornella
Copy link
Member

mcornella commented Aug 7, 2024

I'm a newbie to OMZ. I find your list of plugins to be really interesting, but also rather intimidating. I have no idea of what each one does or which ones I should install. I could click through each link, of course, but with ~100 different options, that's not realistic. I've come across this page several times, and each time I conclude, "this is too complicated" and skip installing plugins.

Some of the underlying packages are self-evident, like "Python." However, most of these names mean nothing to me. E.g., what does "autojump" do?

Even the description after I click through is rather bare: "This plugin loads the autojump navigation tool." This sounds intriguing, but it isn't informative unless (a) you already know what autojump does or (b) you have the time to click through to the underlying package and read the detailed description.

Would it be possible to expand this page with a description for each plugin and the underlying package? The descriptions would ideally have a one or two sentence summary about "why should I care?" -- or "what makes this awesome?" I.e., more than "this plugin loads X" or "this plugin adds syntax highlighting for Y." Rather, there would ideally be a short summary of the underlying package, like "Autojump is X and does Y." Perhaps a table format would work better, not a list.

I'd be happy to volunteer to write a first pass and submit a pull request, although it would require some research and time. I wouldn't want to do this unless there was buy-in. It would help if anyone could volunteer to review a first draft before I submit a formal pull request.

Just my two cents. Thanks for maintaining a great package!

Originally posted by @RobJacobson in ohmyzsh/ohmyzsh#11650

@mcornella
Copy link
Member Author

We can do this automatically with awk by getting the first line of each plugin README.

@mcornella mcornella self-assigned this Aug 7, 2024
@mcornella mcornella transferred this issue from ohmyzsh/ohmyzsh Aug 7, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Main project Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant