repobee / repobee

CLI tool for managing Git repositories on GitHub and GitLab in the context of education
https://repobee.org
MIT License
69 stars 16 forks source link

Make a "Cool things you can do" part of the documentation #813

Open tohanss opened 3 years ago

tohanss commented 3 years ago

Maybe this doesn't have to be part of the documentation, instead, it could be something separate or on the website.

Anyway, I just got the suggestion that we should have a page somewhere where you can see the "cool" things repobee can be used for and I realized that this could be something good to promote repobee. The point here being that showing people how much time they can save is usually more enticing than just telling them that it's a good program.

For example, if we show people this command (and explain how it works etc) * $ repobee issues list -a task-{5..8} -r "[Pp]ass" -q

We can then explain that this single command lets the user find every student that is missing a submission. Easy! Now thats a killer feature

slarse commented 3 years ago

That's a neat idea. I've been thinking about adding something like that for writing plugins, but it would make sense to add it for the built-in commands as well. We could also start highlighting advanced cross-usage of commands.

I think it would make sense to put a "Cool things you can do"-section at the end of each category doc. For example, cool things with the issues commands would go at the end here: https://repobee.readthedocs.io/en/stable/issues.html

Or, we could put it at the end of each individual action. But at the onset when there are just a few "cool things" per category, it might make the reading experience more coherent if we organize them by category instead of action, as many actions are likely to not have a "cool things" section.