diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 2f76af215f..424d110539 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -5,13 +5,13 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Link from "@docusaurus/Link"; import { IconDownload } from "@site/src/components/icons/download"; +import SupportedEnvironments from '@site/src/components/SupportedEnvironments'; +import RateLimits from '@site/src/components/RateLimits'; # Install Goose -:::info Supported Environments -Goose currently works on **macOS** and **Linux** systems and supports both **ARM** and **x86** architectures. If you'd like to request support for additional operating systems, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue). -::: + @@ -130,9 +130,7 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee -:::info Billing -You will need to have credits in your LLM Provider account (when necessary) to be able to successfully make requests. Some providers also have rate limits on API usage, which can affect your experience. Check out the [Handling Rate Limits][handling-rate-limits] guide to learn how to efficiently manage these limits while using Goose. -::: + ## Running Goose diff --git a/documentation/docs/guides/managing-goose-sessions.md b/documentation/docs/guides/managing-goose-sessions.md index 85a1a3106a..5d17ac4a43 100644 --- a/documentation/docs/guides/managing-goose-sessions.md +++ b/documentation/docs/guides/managing-goose-sessions.md @@ -24,6 +24,10 @@ A session is a single, continuous interaction between you and Goose, providing a Type your questions, tasks, or instructions directly into the input field, and Goose will immediately get to work. + ### Start New Session + + To start a new session in the Goose desktop application, click the three dots in the top-right corner of the application and select **New Session** from the dropdown menu. + @@ -95,6 +99,10 @@ A session is a single, continuous interaction between you and Goose, providing a ``` goose session -r -n react-migration ``` + :::tip + While you can resume sessions using the commands above, we recommend creating new sessions for new tasks to reduce the chance of [doom spiraling](/docs/troubleshooting#stuck-in-a-loop-or-unresponsive). + ::: + Session management features, such as **naming** and **resuming** sessions, are **not** currently available in the Goose Desktop. If you'd like to see these features added, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue). diff --git a/documentation/docs/quickstart.md b/documentation/docs/quickstart.md index ca7b14c9d4..443646f906 100644 --- a/documentation/docs/quickstart.md +++ b/documentation/docs/quickstart.md @@ -6,13 +6,13 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Link from "@docusaurus/Link"; import { IconDownload } from "@site/src/components/icons/download"; - +import SupportedEnvironments from '@site/src/components/SupportedEnvironments'; +import RateLimits from '@site/src/components/RateLimits'; # Goose in 5 minutes -:::info Supported Environments -Goose currently works on **macOS** and **Linux** systems and supports both **ARM** and **x86** architectures. If you'd like to request support for additional operating systems, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue). -::: + + Goose is an open source AI agent that supercharges your software development by automating coding tasks. This quick tutorial will guide you through getting started with Goose! @@ -80,11 +80,7 @@ Goose works with [supported LLM providers][providers]. When you install Goose, y -:::info Billing - [Google Gemini](https://aistudio.google.com/app/apikey) offers a free tier you can get started with. Otherwise, you'll need to ensure that you have credits available in your LLM Provider account to successfully make requests. - - Some providers also have rate limits on API usage, which can affect your experience. Check out our [Handling Rate Limits][handling-rate-limits] guide to learn how to efficiently manage these limits while using Goose. -::: + ## Start Session Sessions are single, continuous conversations between you and Goose. Let's start one. diff --git a/documentation/src/components/RateLimits.js b/documentation/src/components/RateLimits.js new file mode 100644 index 0000000000..eea453b59d --- /dev/null +++ b/documentation/src/components/RateLimits.js @@ -0,0 +1,29 @@ +import React from "react"; +import Admonition from "@theme/Admonition"; + +const RateLimits = () => { + return ( + + + Google Gemini + {" "} + offers a free tier you can get started with. Otherwise, you'll need to + ensure that you have credits available in your LLM Provider account to + successfully make requests. +
+
+ Some providers also have rate limits on API usage, which can affect your + experience. Check out our{" "} + + Handling Rate Limits + {" "} + guide to learn how to efficiently manage these limits while using Goose. + + ); +}; + +export default RateLimits; diff --git a/documentation/src/components/SupportedEnvironments.js b/documentation/src/components/SupportedEnvironments.js new file mode 100644 index 0000000000..bba269c013 --- /dev/null +++ b/documentation/src/components/SupportedEnvironments.js @@ -0,0 +1,19 @@ +import React from "react"; +import Admonition from "@theme/Admonition"; + +const SupportedEnvironments = () => { + return ( + + Goose currently works on macOS and Linux systems and supports both ARM and x86 architectures. If you'd like to request support for additional operating systems, please{" "} + + open an issue on GitHub + . + + ); +}; + +export default SupportedEnvironments;