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

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

Open
tohanss opened this issue Jan 27, 2021 · 1 comment
Open

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

tohanss opened this issue Jan 27, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@tohanss
Copy link
Contributor

tohanss commented Jan 27, 2021

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

  • This was the command that led to someone making the suggestion im bringing forth here in this issue. The motivation was: "How am i supposed to know i can do that???"
@tohanss tohanss changed the title [docs] Make a "Cool things you can do" part of the documentation Make a "Cool things you can do" part of the documentation Jan 27, 2021
@slarse
Copy link
Collaborator

slarse commented Jan 31, 2021

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.

@slarse slarse added the documentation Improvements or additions to documentation label Jan 31, 2021
@slarse slarse added the good first issue Good for newcomers label Jan 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants