-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into o1-reasoner
- Loading branch information
Showing
98 changed files
with
1,053 additions
and
759 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Deploy MkDocs | ||
|
||
on: | ||
push: | ||
branches: | ||
- main # Trigger deployment on pushes to main | ||
paths: | ||
- 'docs/**' | ||
- 'mkdocs.yml' | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.x' | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install mkdocs mkdocs-material | ||
- name: Build the documentation | ||
run: mkdocs build | ||
|
||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
This is a python CLI app that uses UV. Read CONTRIBUTING.md for information on how to build and test it as needed. | ||
Some key concepts are that it is run as a command line interface, dependes on the "ai-exchange" package, and has the concept of toolkits which are ways that its behavior can be extended. Look in src/goose and tests. | ||
Once the user has UV installed it should be able to be used effectively along with uvx to run tasks as needed | ||
Once the user has UV installed it should be able to be used effectively along with uvx to run tasks as needed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
|
||
<p> | ||
<a href="#prerequisites">Prerequisites</a> • | ||
<a href="#evaluations">Evaluations</a> • | ||
<a href="#developing-and-testing">Developing and testing</a> • | ||
<a href="#building-from-source">Building from source</a> • | ||
<a href="#developing-goose-plugins">Developing goose-plugins</a> • | ||
|
@@ -37,7 +36,7 @@ Plugins added directly to Goose are subject to rigorous review. This is because | |
|
||
Plugins in `goose-plugins` undergo less detailed reviews and are more modular or experimental. They can prove their value through usage or iteration over time and may be eventually moved over to Goose. | ||
|
||
To see how to add a toolkit, see the [toolkits documentation][toolkits]. | ||
To see how to add a toolkit, see the [toolkits documentation][adding-toolkit]. | ||
|
||
### Running tests | ||
```sh | ||
|
@@ -56,7 +55,7 @@ If you want to develop features on `goose`: | |
|
||
1. Clone Goose: | ||
```bash | ||
git clone [email protected]:square/goose.git ~/Development/goose | ||
git clone [email protected]:block-open-source/goose.git ~/Development/goose | ||
``` | ||
2. Get `uv` with `brew install uv` | ||
3. Set up your Python virtualenv: | ||
|
@@ -83,7 +82,7 @@ When you build from source you may want to run it from elsewhere. | |
|
||
1. Clone the `goose-plugins` repo: | ||
```bash | ||
git clone [email protected]:square/goose-plugins.git ~/Development/goose-plugins | ||
git clone [email protected]:block-open-source/goose-plugins.git ~/Development/goose-plugins | ||
``` | ||
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`: | ||
|
@@ -116,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. | ||
|
||
[issues]: https://github.com/square/goose/issues | ||
[goose-plugins]: https://github.com/square/goose-plugins | ||
[issues]: https://github.com/block-open-source/goose/issues | ||
[goose-plugins]: https://github.com/block-open-source/goose-plugins | ||
[ai-exchange]: https://github.com/square/exchange | ||
[developer]: src/goose/toolkit/developer.py | ||
[uv]: https://docs.astral.sh/uv/ | ||
[ruff]: https://docs.astral.sh/ruff/ | ||
[just]: https://github.com/casey/just | ||
[toolkits]: docs/docs/toolkits.md | ||
[adding-toolkit]: https://block-open-source.github.io/goose/configuration.html#adding-a-toolkit |
Oops, something went wrong.