Address Documentation Feedback and Add Reusable Components (#820)

This commit is contained in:
Ebony Louis
2025-01-27 17:53:21 -05:00
committed by GitHub
parent 0488bd006d
commit 3dc4bbb569
5 changed files with 65 additions and 15 deletions

View File

@@ -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).
:::
<SupportedEnvironments />
<Tabs groupId="interface">
@@ -130,9 +130,7 @@ Goose works with a set of [supported LLM providers][providers], and youll nee
</TabItem>
</Tabs>
:::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.
:::
<RateLimits />
## Running Goose

View File

@@ -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.
</TabItem>
</Tabs>
@@ -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).
:::
</TabItem>
<TabItem value="ui" label="Goose Desktop">
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).

View File

@@ -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).
:::
<SupportedEnvironments />
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
</TabItem>
</Tabs>
:::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.
:::
<RateLimits />
## Start Session
Sessions are single, continuous conversations between you and Goose. Let's start one.

View File

@@ -0,0 +1,29 @@
import React from "react";
import Admonition from "@theme/Admonition";
const RateLimits = () => {
return (
<Admonition type="info" title="Billing">
<a
href="https://aistudio.google.com/app/apikey"
target="_blank"
rel="noopener noreferrer"
>
Google Gemini
</a>{" "}
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.
<br />
<br />
Some providers also have rate limits on API usage, which can affect your
experience. Check out our{" "}
<a href="/docs/guides/handling-llm-rate-limits" target="_blank">
Handling Rate Limits
</a>{" "}
guide to learn how to efficiently manage these limits while using Goose.
</Admonition>
);
};
export default RateLimits;

View File

@@ -0,0 +1,19 @@
import React from "react";
import Admonition from "@theme/Admonition";
const SupportedEnvironments = () => {
return (
<Admonition type="info" title="Supported Environments">
Goose currently works on <strong>macOS</strong> and <strong>Linux</strong> systems and supports both <strong>ARM</strong> and <strong>x86</strong> architectures. If you'd like to request support for additional operating systems, please{" "}
<a
href="https://github.com/block/goose/issues/new?template=Blank+issue"
target="_blank"
rel="noopener noreferrer"
>
open an issue on GitHub
</a>.
</Admonition>
);
};
export default SupportedEnvironments;