docs: update docs (#99)
This commit is contained in:
+5
-5
@@ -55,7 +55,7 @@ If you want to develop features on `goose`:
|
|||||||
|
|
||||||
1. Clone Goose:
|
1. Clone Goose:
|
||||||
```bash
|
```bash
|
||||||
git clone git@github.com:square/goose.git ~/Development/goose
|
git clone git@github.com:block-open-source/goose.git ~/Development/goose
|
||||||
```
|
```
|
||||||
2. Get `uv` with `brew install uv`
|
2. Get `uv` with `brew install uv`
|
||||||
3. Set up your Python virtualenv:
|
3. Set up your Python virtualenv:
|
||||||
@@ -82,7 +82,7 @@ When you build from source you may want to run it from elsewhere.
|
|||||||
|
|
||||||
1. Clone the `goose-plugins` repo:
|
1. Clone the `goose-plugins` repo:
|
||||||
```bash
|
```bash
|
||||||
git clone git@github.com:square/goose-plugins.git ~/Development/goose-plugins
|
git clone git@github.com:block-open-source/goose-plugins.git ~/Development/goose-plugins
|
||||||
```
|
```
|
||||||
2. Follow the steps for creating a virtualenv in the `goose` section above
|
2. Follow the steps for creating a virtualenv in the `goose` section above
|
||||||
3. Install `goose-plugins` in `goose`. This means any changes to `goose-plugins` in this folder will immediately be reflected in `goose`:
|
3. Install `goose-plugins` in `goose`. This means any changes to `goose-plugins` in this folder will immediately be reflected in `goose`:
|
||||||
@@ -115,11 +115,11 @@ Additions to the [developer toolkit][developer] change the core performance, and
|
|||||||
|
|
||||||
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for PR titles. Conventional Commits make it easier to understand the history of a project and facilitate automation around versioning and changelog generation.
|
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for PR titles. Conventional Commits make it easier to understand the history of a project and facilitate automation around versioning and changelog generation.
|
||||||
|
|
||||||
[issues]: https://github.com/square/goose/issues
|
[issues]: https://github.com/block-open-source/goose/issues
|
||||||
[goose-plugins]: https://github.com/square/goose-plugins
|
[goose-plugins]: https://github.com/block-open-source/goose-plugins
|
||||||
[ai-exchange]: https://github.com/square/exchange
|
[ai-exchange]: https://github.com/square/exchange
|
||||||
[developer]: src/goose/toolkit/developer.py
|
[developer]: src/goose/toolkit/developer.py
|
||||||
[uv]: https://docs.astral.sh/uv/
|
[uv]: https://docs.astral.sh/uv/
|
||||||
[ruff]: https://docs.astral.sh/ruff/
|
[ruff]: https://docs.astral.sh/ruff/
|
||||||
[just]: https://github.com/casey/just
|
[just]: https://github.com/casey/just
|
||||||
[adding-toolkit]: https://square.github.io/goose/configuration.html#adding-a-toolkit
|
[adding-toolkit]: https://block-open-source.github.io/goose/configuration.html#adding-a-toolkit
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl
|
|||||||
<img src="docs/assets/goose.png" width="400" height="400" alt="Goose Drawing"/>
|
<img src="docs/assets/goose.png" width="400" height="400" alt="Goose Drawing"/>
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Generated by Goose from its <a href="https://github.com/square/goose-plugins/blob/main/src/goose_plugins/toolkits/artify.py">VincentVanCode toolkit</a>.
|
Generated by Goose from its <a href="https://github.com/block-open-source/goose-plugins/blob/main/src/goose_plugins/toolkits/artify.py">VincentVanCode toolkit</a>.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://square.github.io/goose/"><img src="https://img.shields.io/badge/Documentation-goose_docs-blue"></a>
|
<a href="https://block-open-source.github.io/goose/"><img src="https://img.shields.io/badge/Documentation-goose_docs-blue"></a>
|
||||||
<a href=[goose-ai-pypi]><img src="https://img.shields.io/pypi/v/goose-ai"></a>
|
<a href=[goose-ai-pypi]><img src="https://img.shields.io/pypi/v/goose-ai"></a>
|
||||||
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg">
|
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg">
|
||||||
</a>
|
</a>
|
||||||
|
|||||||
@@ -91,4 +91,4 @@ goose session start --profile demo-profile
|
|||||||
> `pipx install goose-ai --preinstall goose-plugins`
|
> `pipx install goose-ai --preinstall goose-plugins`
|
||||||
|
|
||||||
[plugin]: https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#using-package-metadata
|
[plugin]: https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#using-package-metadata
|
||||||
[goose-plugins]: https://github.com/square/goose-plugins
|
[goose-plugins]: https://github.com/block-open-source/goose-plugins
|
||||||
|
|||||||
+2
-2
@@ -2,7 +2,7 @@ site_name: Goose Documentation
|
|||||||
site_author: Block
|
site_author: Block
|
||||||
site_description: Documentation for Goose
|
site_description: Documentation for Goose
|
||||||
repo_url: https://github.com/block-open-source/goose
|
repo_url: https://github.com/block-open-source/goose
|
||||||
repo_name: "square/goose"
|
repo_name: "block-open-source/goose"
|
||||||
edit_uri: "https://github.com/block-open-source/goose/blob/main/docs/"
|
edit_uri: "https://github.com/block-open-source/goose/blob/main/docs/"
|
||||||
site_url: 'https://block-open-source.github.io/goose/'
|
site_url: 'https://block-open-source.github.io/goose/'
|
||||||
use_directory_urls: false
|
use_directory_urls: false
|
||||||
@@ -57,7 +57,7 @@ plugins:
|
|||||||
- git-committers: # Show git committers
|
- git-committers: # Show git committers
|
||||||
branch: main
|
branch: main
|
||||||
enabled: !ENV [ ENV_PROD, false ]
|
enabled: !ENV [ ENV_PROD, false ]
|
||||||
repository: square/goose
|
repository: block-open-source/goose
|
||||||
- git-revision-date-localized: # Show git revision date
|
- git-revision-date-localized: # Show git revision date
|
||||||
enable_creation_date: true
|
enable_creation_date: true
|
||||||
enabled: !ENV [ ENV_PROD, false ]
|
enabled: !ENV [ ENV_PROD, false ]
|
||||||
|
|||||||
Reference in New Issue
Block a user