docs: lowercase goose in getting-started and guides topics (#5857)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
dianed-square
@@ -7,7 +7,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import { PanelLeft, Paperclip, Edit2, Send, GripVertical, X, ChevronUp, ChevronDown } from 'lucide-react';
|
||||
|
||||
Goose provides features you can use to manage conversations and share information during sessions.
|
||||
goose provides features you can use to manage conversations and share information during sessions.
|
||||
|
||||
## Edit Message
|
||||
|
||||
@@ -18,7 +18,7 @@ Editing any message in the session gives you complete control over the conversat
|
||||
This is useful when:
|
||||
|
||||
- You realize a prompt you sent was unclear or incomplete
|
||||
- Goose misunderstood your intent and went in the wrong direction
|
||||
- goose misunderstood your intent and went in the wrong direction
|
||||
- You want to try different approaches to a problem without starting a new session
|
||||
|
||||
<Tabs groupId="interface">
|
||||
@@ -27,12 +27,12 @@ This is useful when:
|
||||
1. Hover over any of your previous messages to reveal the edit button
|
||||
2. Click the <Edit2 className="inline" size={16} /> edit button that appears
|
||||
3. Make your changes in the inline editor
|
||||
4. Click `Save` to save your changes and reprompt Goose (or use `Cmd+Enter` (macOS) or `Ctrl+Enter` (Windows/Linux))
|
||||
4. Click `Save` to save your changes and reprompt goose (or use `Cmd+Enter` (macOS) or `Ctrl+Enter` (Windows/Linux))
|
||||
|
||||
Goose removes all conversation history after the edited message and responds contextually from that point.
|
||||
goose removes all conversation history after the edited message and responds contextually from that point.
|
||||
|
||||
:::warning Deleted Context
|
||||
Subsequent conversation history is permanently deleted from the session and removed from Goose's context. Edit a message only if you don't need Goose to remember the context that follows it.
|
||||
Subsequent conversation history is permanently deleted from the session and removed from goose's context. Edit a message only if you don't need goose to remember the context that follows it.
|
||||
:::
|
||||
|
||||
#### Example Message Flow
|
||||
@@ -53,43 +53,43 @@ This is useful when:
|
||||
|
||||
#### Editing Scenario Tips
|
||||
|
||||
- **Iterative Prompt Refinement**: Start with a basic prompt, then edit and refine based on Goose's response. This often works better than trying to craft the perfect prompt from the start.
|
||||
- **Iterative Prompt Refinement**: Start with a basic prompt, then edit and refine based on goose's response. This often works better than trying to craft the perfect prompt from the start.
|
||||
- **When to Edit vs. Interrupt**: Editing earlier messages when a conversation has gone off track can be more effective than trying to correct course using new messages or [interruptions](#interrupt-task). By editing messages, you rewrite history. With interruptions, you only affect the conversation from the current message onwards.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli" label="goose CLI">
|
||||
Message editing is not available in the Goose CLI.
|
||||
Message editing is not available in the goose CLI.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Queue Messages
|
||||
|
||||
Queue messages while Goose is processing a task to manage your workflow. This is useful when:
|
||||
Queue messages while goose is processing a task to manage your workflow. This is useful when:
|
||||
|
||||
- You want to prepare next steps while Goose is working
|
||||
- You want to prepare next steps while goose is working
|
||||
- You have a sequence of related tasks to complete
|
||||
- You're using [voice dictation](#voice-dictation) and need to capture thoughts quickly
|
||||
|
||||
:::tip
|
||||
Goose may perform better when complex tasks are split into subtasks, a technique called [*prompt chaining*](https://www.promptingguide.ai/techniques/prompt_chaining). This structured approach can both improve accuracy and give you more control over the process.
|
||||
goose may perform better when complex tasks are split into subtasks, a technique called [*prompt chaining*](https://www.promptingguide.ai/techniques/prompt_chaining). This structured approach can both improve accuracy and give you more control over the process.
|
||||
:::
|
||||
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="goose Desktop" default>
|
||||
Add a message to the queue:
|
||||
1. While Goose is processing a response, type your next message
|
||||
1. While goose is processing a response, type your next message
|
||||
2. Press `Enter` to add it to the queue (or interrupts if using [interruption keywords](#interrupt-task))
|
||||
|
||||
Queued messages appear as numbered cards showing the queue order. The first message in the queue is automatically sent when Goose finishes each response.
|
||||
Queued messages appear as numbered cards showing the queue order. The first message in the queue is automatically sent when goose finishes each response.
|
||||
|
||||
:::info Related Features
|
||||
- In general, pressing `Enter` while Goose is processing a task queues the message, but clicking `Send` sends the task immediately and [interrupts the task](#interrupt-task)
|
||||
- When you type common interrupt keywords like "stop", "wait", or "hold on" in a queued message, Goose pauses until you enter or send the next message and then continues processing the queue
|
||||
- In general, pressing `Enter` while goose is processing a task queues the message, but clicking `Send` sends the task immediately and [interrupts the task](#interrupt-task)
|
||||
- When you type common interrupt keywords like "stop", "wait", or "hold on" in a queued message, goose pauses until you enter or send the next message and then continues processing the queue
|
||||
:::
|
||||
|
||||
#### Queue Management Controls
|
||||
|
||||
Queued messages run automatically in order as Goose finishes each task, but you can manage the queue:
|
||||
Queued messages run automatically in order as goose finishes each task, but you can manage the queue:
|
||||
- **Edit a message**: Click the message text to reveal the edit controls, then type your change and click `Save`
|
||||
- **Reorder messages**: Hover over the message card to reveal the <GripVertical className="inline" size={16} /> button, then grab it and drag the message up or down
|
||||
- **Send a message**: Click the <Send className="inline" size={16} /> button to send a message immediately and interrupt the current task
|
||||
@@ -103,12 +103,12 @@ Goose may perform better when complex tasks are split into subtasks, a technique
|
||||
|
||||
You send: "Can you refactor our authentication code to support OAuth 2.0 and add proper error handling? Also include unit tests for the OAuth flow, update the API documentation to reflect these changes, and create a migration script to help existing users transition to the new system."
|
||||
|
||||
This approach might lead to overwhelming responses where important details get missed or tasks are handled superficially. Even sending a single prompt with clear sequential steps doesn't allow Goose to focus on each task individually or build context progressively.
|
||||
This approach might lead to overwhelming responses where important details get missed or tasks are handled superficially. Even sending a single prompt with clear sequential steps doesn't allow goose to focus on each task individually or build context progressively.
|
||||
|
||||
**With queuing:**
|
||||
|
||||
1. You send: "Refactor the authentication code to support OAuth 2.0"
|
||||
2. While Goose is working, you queue the following messages:
|
||||
2. While goose is working, you queue the following messages:
|
||||
- "And add proper error handling"
|
||||
- "Add unit tests for the OAuth flow"
|
||||
- "Update the API documentation"
|
||||
@@ -118,15 +118,15 @@ Goose may perform better when complex tasks are split into subtasks, a technique
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli" label="goose CLI">
|
||||
Message queuing is not available in the Goose CLI.
|
||||
Message queuing is not available in the goose CLI.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Interrupt Task
|
||||
|
||||
Interrupt Goose while it's processing a task to take control of the conversation. This is useful when:
|
||||
Interrupt goose while it's processing a task to take control of the conversation. This is useful when:
|
||||
|
||||
- Goose is heading in the wrong direction
|
||||
- goose is heading in the wrong direction
|
||||
- You realize you need to add important context
|
||||
- You want to switch to a completely different task
|
||||
|
||||
@@ -139,7 +139,7 @@ Interrupt Goose while it's processing a task to take control of the conversation
|
||||
1. Type a prompt that includes common interruption keywords like `stop`, `wait`, `hold on`, `actually`, or `instead`. Using keywords alone or at the beginning of sentences works best for reliable detection.
|
||||
2. Click `Send`
|
||||
|
||||
Goose stops processing the current task and asks for more information.
|
||||
goose stops processing the current task and asks for more information.
|
||||
|
||||
#### Provide immediate redirection
|
||||
1. Type a prompt with more context and clarification or that changes direction. For example:
|
||||
@@ -147,11 +147,11 @@ Interrupt Goose while it's processing a task to take control of the conversation
|
||||
- "Let's focus on React instead of TypeScript"
|
||||
2. Click `Send`
|
||||
|
||||
Goose stops processing the current task and pivots to the new request context.
|
||||
goose stops processing the current task and pivots to the new request context.
|
||||
|
||||
:::info Related features
|
||||
- Clicking `Send` while Goose is processing a task interrupts the task but pressing `Enter` [queues the message](#queue-messages)
|
||||
- Typing a stop or pause keyword in a queued message also stops Goose from processing the current task
|
||||
- Clicking `Send` while goose is processing a task interrupts the task but pressing `Enter` [queues the message](#queue-messages)
|
||||
- Typing a stop or pause keyword in a queued message also stops goose from processing the current task
|
||||
- You can also [edit a sent message](#edit-message) to provide more context and clarification or change direction during a session
|
||||
:::
|
||||
|
||||
@@ -189,13 +189,13 @@ Interrupt Goose while it's processing a task to take control of the conversation
|
||||
2. Type your prompt that provides more context or changes direction
|
||||
3. Press `Enter`
|
||||
|
||||
Goose responds contextually to your new request.
|
||||
goose responds contextually to your new request.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Voice Dictation
|
||||
Speak to Goose directly instead of typing your prompts.
|
||||
Speak to goose directly instead of typing your prompts.
|
||||
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="goose Desktop" default>
|
||||
@@ -211,9 +211,9 @@ Speak to Goose directly instead of typing your prompts.
|
||||
1. Return to the chat interface (click `Chat` in the sidebar)
|
||||
2. Click the microphone on the right of the chat box and begin speaking
|
||||
|
||||
The first time you use voice dictation, Goose will request access to your microphone. While recording, you'll see a live waveform of your audio in the input field, a timer, and the current size of your recording. Click the microphone button again to finish recording.
|
||||
The first time you use voice dictation, goose will request access to your microphone. While recording, you'll see a live waveform of your audio in the input field, a timer, and the current size of your recording. Click the microphone button again to finish recording.
|
||||
|
||||
**If you don't see the microphone**, check the [models you have configured](/docs/getting-started/providers.md). ElevenLabs can be used as a dictation provider alongside any LLM, but OpenAI Whisper requires that you have an OpenAI model configured in Goose, even if using another LLM provider for chat.
|
||||
**If you don't see the microphone**, check the [models you have configured](/docs/getting-started/providers.md). ElevenLabs can be used as a dictation provider alongside any LLM, but OpenAI Whisper requires that you have an OpenAI model configured in goose, even if using another LLM provider for chat.
|
||||
|
||||
#### Important Notes
|
||||
* You can record up to 10 minutes or 25MB of audio
|
||||
@@ -223,17 +223,17 @@ Speak to Goose directly instead of typing your prompts.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli" label="goose CLI">
|
||||
Voice dictation is not available in the Goose CLI.
|
||||
Voice dictation is not available in the goose CLI.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Share Files in Session
|
||||
|
||||
Provide Goose with context from your codebase, documents, and other files to get more relevant and accurate assistance.
|
||||
Provide goose with context from your codebase, documents, and other files to get more relevant and accurate assistance.
|
||||
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="goose Desktop" default>
|
||||
Share files with Goose in several ways:
|
||||
Share files with goose in several ways:
|
||||
|
||||
1. **Drag and Drop**: Simply drag files from your computer's file explorer/finder and drop them anywhere in the chat window. The file paths will be automatically added to your message.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user