Add some tips on effective watson usage #438
Conversation
There was a problem hiding this comment.
Thank you for this @joelostblom! 🙏
I find it cool but a little bit too opinionated 😉 Maybe we should add a new "real world use cases" section in the documentation to introduce examples of Watson usage?
| @@ -638,7 +638,7 @@ in the future. | |||
| Example: | |||
|
|
|||
|
|
|||
| $ watson start --at 13:37 | |||
| $ watson start appollo11 --at 13:37 | |||
There was a problem hiding this comment.
| $ watson start appollo11 --at 13:37 | |
| $ watson start apollo11 --at 13:37 |
| @@ -230,7 +230,7 @@ def start(ctx, watson, confirm_new_project, confirm_new_tag, args, at_, | |||
| Example: | |||
|
|
|||
| \b | |||
| $ watson start --at 13:37 | |||
| $ watson start appollo11 --at 13:37 | |||
There was a problem hiding this comment.
| $ watson start appollo11 --at 13:37 | |
| $ watson start apollo11 --at 13:37 |
|
Haha yes, it is definitely opinionated =) I like the idea of real world usage scenarios, that's what I was trying to get at with my second suggestion. Where do you want that section? As a third entry in the "User guide" after "Commands" and "Configuration"? I can add my story for now and change it to a more personal narrative and encourage others to share their tips/setup/workflows. I feel like this sharing of knowledge could be good for community building too, not sure about the exact format, but something like this:
|
Yes, good idea! Few years ago, I wrote a narrative about Watson usage: https://tailordev.fr/blog/2016/02/05/a-day-tracking-my-time-with-watson/ Not sure it's still relevant now... |
I think it would be helpful to expand on the "getting started" section with some more pointers for how to be effective with watson. The ones suggested in this PR are obviously colored by how I use watson and I am happy for them to be replaced with something more general, or maybe better: for there to be a section where users can share their specific workflows (although that might be more hidden for people going to the website).
Fun groovy gifs like this one can be added if desired to match the cat:
I also fixed a typo I noticed when reading the docs.