From dccf0ec67c588930964a4e86a170a237798cd580 Mon Sep 17 00:00:00 2001 From: Lam Chau Date: Thu, 24 Oct 2024 15:25:37 -0700 Subject: [PATCH] docs: fix mkdocs, update to new references (#193) --- docs/index.md | 28 +++++++++---------- docs/plugins/cli.md | 2 ++ .../goose/utils/check_shell_command.md | 1 - .../goose/utils/shell/is_dangerous_command.md | 1 + docs/reference/index.md | 4 +-- 5 files changed, 19 insertions(+), 17 deletions(-) delete mode 100644 docs/reference/goose/utils/check_shell_command.md create mode 100644 docs/reference/goose/utils/shell/is_dangerous_command.md diff --git a/docs/index.md b/docs/index.md index 494f1b93..9096482a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,13 +20,13 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl - Discord + Discord

Unique features šŸ¤– ā€¢ - Block Employees on Goose Block Emoji ā€¢ + Block Employees on Goose Block Emoji ā€¢ Quick start guide šŸš€ ā€¢ Getting involved! šŸ‘‹

@@ -65,7 +65,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl -- M, Software Engineer -> If anyone was looking for another reason to check it out: I just asked Goose to break a string-array into individual string resources across eleven localizations, and it performed amazingly well and saved me a bunch of time doing it manually or figuring out some way to semi-automate it. +> If anyone was looking for another reason to check it out: I just asked Goose to break a string-array into individual string resources across eleven localizations, and it performed amazingly well and saved me a bunch of time doing it manually or figuring out some way to semi-automate it. -- A, Android Engineer @@ -101,7 +101,7 @@ To install Goose, use `pipx`. First ensure [pipx][pipx] is installed: brew install pipx pipx ensurepath ``` -You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you. +You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you. Then install Goose: @@ -111,7 +111,7 @@ pipx install goose-ai ### Running Goose -#### Start a session +#### Start a session From your terminal, navigate to the directory you'd like to start from and run: @@ -127,11 +127,11 @@ GāÆ type your instructions here exactly as you would tell a developer. Now you are interacting with Goose in conversational sessions - think of it as like giving direction to a junior developer. The default toolkit allows Goose to take actions through shell commands and file edits. You can interrupt Goose with `CTRL+D` or `ESC+Enter` at any time to help redirect its efforts. -#### Exit the session +#### Exit the session -If you are looking to exit, use `CTRL+D`, although Goose should help you figure that out if you forget. +If you are looking to exit, use `CTRL+D`, although Goose should help you figure that out if you forget. -#### Resume a session +#### Resume a session When you exit a session, it will save the history in `~/.config/goose/sessions` directory and you can resume it later on: @@ -143,7 +143,7 @@ To see more documentation on the CLI commands currently available to Goose check ### Running a goose tasks (one off) -You can run goose to do things just as a one off, such as tidying up, and then exiting: +You can run goose to do things just as a one off, such as tidying up, and then exiting: ```sh goose run instructions.md @@ -162,10 +162,10 @@ This will run until completion as best it can. You can also pass `--resume-sessi Learn how to modify your Goose profiles.yaml file to add and remove functionality (toolkits) and providing context to get the most out of Goose in our [Getting Started Guide][getting-started]. -**Want to move out of the terminal and into an IDE?** +**Want to move out of the terminal and into an IDE?** -We have some experimental IDE integrations for VSCode and JetBrains IDEs: -* https://github.com/square/goose-vscode +We have some experimental IDE integrations for VSCode and JetBrains IDEs: +* https://github.com/square/goose-vscode * https://github.com/Kvadratni/goose-intellij ## Other ways to run goose @@ -178,7 +178,7 @@ We have some experimental IDE integrations for VSCode and JetBrains IDEs: **Goose as a Github Action** -There is also an experimental Github action to run goose as part of your workflow (for example if you ask it to fix an issue): +There is also an experimental Github action to run goose as part of your workflow (for example if you ask it to fix an issue): https://github.com/marketplace/actions/goose-ai-developer-agent **With Docker** @@ -201,7 +201,7 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [goose-plugins]: https://github.com/block-open-source/goose-plugins [pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx -[contributing]: https://github.com/block/goose/blob/main/CONTRIBUTING.md +[contributing]: https://block.github.io/goose/contributing.html [license]: https://github.com/block/goose/blob/main/LICENSE [goose-docs]: https://block.github.io/goose/ diff --git a/docs/plugins/cli.md b/docs/plugins/cli.md index 7a3566d3..02ce87c2 100644 --- a/docs/plugins/cli.md +++ b/docs/plugins/cli.md @@ -63,3 +63,5 @@ Deletes old Goose sessions, keeping the most recent ones as specified by the `-- ``` Lists all available toolkits with their descriptions. + +[contributing]: https://block.github.io/goose/contributing.html diff --git a/docs/reference/goose/utils/check_shell_command.md b/docs/reference/goose/utils/check_shell_command.md deleted file mode 100644 index d2866559..00000000 --- a/docs/reference/goose/utils/check_shell_command.md +++ /dev/null @@ -1 +0,0 @@ -::: goose.utils.check_shell_command \ No newline at end of file diff --git a/docs/reference/goose/utils/shell/is_dangerous_command.md b/docs/reference/goose/utils/shell/is_dangerous_command.md new file mode 100644 index 00000000..e37fddee --- /dev/null +++ b/docs/reference/goose/utils/shell/is_dangerous_command.md @@ -0,0 +1 @@ +::: goose.utils.shell.is_dangerous_command diff --git a/docs/reference/index.md b/docs/reference/index.md index ac3905df..cbcb8e4d 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -33,6 +33,6 @@ ## Utils - [goose.utils](goose/utils/index.md) - [goose.utils.ask](goose/utils/ask.md) -- [goose.utils.check_shell_command](goose/utils/check_shell_command.md) - [goose.utils.file_utils](goose/utils/file_utils.md) -- [goose.utils.session_file](goose/utils/session_file.md) \ No newline at end of file +- [goose.utils.session_file](goose/utils/session_file.md) +- [goose.utils.shell.is_dangerous_command](goose/utils/shell/is_dangerous_command.md)