-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Docs quick tip slot4 #4948
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
Docs quick tip slot4 #4948
Conversation
Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com>
Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com>
documentation/docs/guides/tips.md
Outdated
| ### Use `goose shortcuts` to speed up workflows | ||
| Goose can execute common tasks faster using predefined shortcuts. Instead of typing long commands or performing repetitive actions, define a shortcut once and reuse it anytime. | ||
| Example: `goose shortcuts add deploy "run deployment script"` lets you deploy quickly by simply running `goose deploy`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where are you getting these commands from? I dont think they exist.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @blackgirlbytes 👋
I've updated the Quick Tips to only include verified Goose functionality.
- Removed unverified commands like
goose devandgoose shortcuts. - Added tips on automating tasks safely and using context files (
.goosehints) to save preferences.
All content is aligned with the official Goose docs: https://block.github.io/goose/docs/category/guides
Thanks for reviewing! 🚀
Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com>
df6868d to
9f95ae9
Compare
documentation/docs/guides/tips.md
Outdated
| ### Automate repetitive tasks safely | ||
| Goose can help streamline your workflow by automating repetitive tasks. Before automating, clearly define the task and test it on a small scale. This ensures predictable results while saving time on routine actions without risking critical files or data. | ||
|
|
||
| ### Use context files to save your preferences |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Shahzebdevv ! Couple of notes for you:
- Could you make sure to check that these tips aren't mentioned in the goose docs already? For example, goose remembering project-specific preferences is already mentioned here:
- The tips the community are hoping for come from using goose and sharing shortcuts or reminders learned from that experience using it. While you are welcome to use AI to assist your contributions (view our AI-assisted guide here), it's important that tips added are helpful and not redundant.
If you don't find something for this, maybe submitting a recipe in #4755 or prompt for our prompt library #4758 would be more fun and beneficial for both you and the community. Let me know what you think!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also closed #4946 as that had duplicate work that can instead be contained in this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @taniandjerry @blackgirlbytes 👋
Thanks so much for the feedback! I’ve updated Slot 4 to remove the unverified commands and replaced it with a practical, verified tip that’s easy to apply when working with Goose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about this quick tip with environment variables, what do you think @blackgirlbytes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm yeah not really a quick tip in reference to goose.
okay, here's an idea . do a quick tip about lead/worker mode or autopilot. This allows people to mix and match multiple models throughout the process..allowing one to be strong at reasoning and one to be good at speed.
https://block.github.io/goose/docs/tutorials/lead-worker
this also helps people to save money
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @taniandjerry @blackgirlbytes 👋
Thanks so much for the feedback! I’ve updated the quick tip. Please check them out and let me know
…rets Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com>
|
Let us know if you have a chance to address this based on @blackgirlbytes' suggestion, @Shahzebdevv ! |
|
@taniandjerry yes I'm working on it |
Signed-off-by: Shahzebdevv <shahzebalam14feb@gmail.com> :wq
96c7f40 to
cc0eeb6
Compare
taniandjerry
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Shahzebdevv - Sorry to come back to this late! I updated the language of tips you provided to get your submission merged. ❤️
The reason being, the tips as you had submitted them addressed feedback yes, but felt more like describing a feature vs helping the reader understand when to consider using a feature in an accessible way. Hope that makes sense! Thank you so much for contributing.
Spoke to Rizel and made sure her feedback was addressed in the latest version! Dismissing vs requesting re-review since Rizel is away at a conference.
|
Hey @taniandjerry @blackgirlbytes 👋 |
Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com> Co-authored-by: taniandjerry <126204004+taniandjerry@users.noreply.github.com> Signed-off-by: fbalicchia <fbalicchia@gmail.com>
Signed-off-by: Mohammad Shahzeb Alam <shahzebalam14feb@gmail.com> Co-authored-by: taniandjerry <126204004+taniandjerry@users.noreply.github.com> Signed-off-by: Blair Allan <Blairallan@icloud.com>
Summary
Added a new Goose Quick Tip (Slot 4) to provide users with a faster feedback workflow when iterating on projects. This tip helps users run
goose devinstead ofgoose buildfor quicker feedback loops.Type of Change
Testing
Related Issues
Relates to #4754
Screenshots/Demos (for UX changes)
N/A – Documentation only
Email: shahzebalam14feb@gmail.com