goose/documentation
Michael Neale 7449a96664
Some checks failed
Canary / Prepare Version (push) Waiting to run
Canary / build-cli (push) Blocked by required conditions
Canary / Upload Install Script (push) Blocked by required conditions
Canary / bundle-desktop (push) Blocked by required conditions
Canary / bundle-desktop-intel (push) Blocked by required conditions
Canary / bundle-desktop-linux (push) Blocked by required conditions
Canary / bundle-desktop-windows (push) Blocked by required conditions
Canary / Release (push) Blocked by required conditions
Unused Dependencies / machete (push) Waiting to run
CI / changes (push) Waiting to run
CI / Check Rust Code Format (push) Blocked by required conditions
CI / Build and Test Rust Project (push) Blocked by required conditions
CI / Build Rust Project on Windows (push) Waiting to run
CI / Lint Rust Code (push) Blocked by required conditions
CI / Check OpenAPI Schema is Up-to-Date (push) Blocked by required conditions
CI / Test and Lint Electron Desktop App (push) Blocked by required conditions
Live Provider Tests / check-fork (push) Waiting to run
Live Provider Tests / changes (push) Blocked by required conditions
Live Provider Tests / Build Binary (push) Blocked by required conditions
Live Provider Tests / Smoke Tests (push) Blocked by required conditions
Live Provider Tests / Smoke Tests (Code Execution) (push) Blocked by required conditions
Live Provider Tests / Compaction Tests (push) Blocked by required conditions
Live Provider Tests / goose server HTTP integration tests (push) Blocked by required conditions
Publish Docker Image / docker (push) Waiting to run
Scorecard supply-chain security / Scorecard analysis (push) Waiting to run
Cargo Deny / deny (push) Has been cancelled
Deploy Documentation / deploy (push) Has been cancelled
Publish Ask AI Bot Docker Image / docker (push) Has been cancelled
Publish to npm / Generate ACP Schema (push) Has been cancelled
Publish to npm / Build goose CLI (darwin-arm64) (push) Has been cancelled
Publish to npm / Build goose CLI (darwin-x64) (push) Has been cancelled
Publish to npm / Build goose CLI (linux-arm64) (push) Has been cancelled
Publish to npm / Build goose CLI (linux-x64) (push) Has been cancelled
Publish to npm / Release to npm (push) Has been cancelled
docs: rework homepage and add aaif migration blog post (#8356)
Signed-off-by: Michael Neale <michael.neale@gmail.com>
2026-04-07 07:18:04 +00:00
..
.goose/memory Prompt Library (#1906) 2025-03-31 07:29:37 -04:00
automation chore(aaif): rename a bunch of repository references (#8152) 2026-04-07 15:34:48 +10:00
blog docs: rework homepage and add aaif migration blog post (#8356) 2026-04-07 07:18:04 +00:00
docs docs: rework homepage and add aaif migration blog post (#8356) 2026-04-07 07:18:04 +00:00
plugins [docs] Add OSS Skills Marketplace (#6752) 2026-01-28 22:46:18 -05:00
scripts chore(aaif): rename a bunch of repository references (#8152) 2026-04-07 15:34:48 +10:00
src docs: rework homepage and add aaif migration blog post (#8356) 2026-04-07 07:18:04 +00:00
static chore(aaif): rename a bunch of repository references (#8152) 2026-04-07 15:34:48 +10:00
.gitignore [docs] Add OSS Skills Marketplace (#6752) 2026-01-28 22:46:18 -05:00
.goosehints Add .goosehints file to enforce lowercase branding in documentation (#4870) 2025-09-28 23:53:56 -04:00
.npmrc feat: V1.0 (#734) 2025-01-24 13:04:43 -08:00
AGENTS.md adding brand guidelines to AGENTS.md (#4887) 2025-10-08 15:27:19 -04:00
docusaurus.config.ts chore(aaif): rename a bunch of repository references (#8152) 2026-04-07 15:34:48 +10:00
package-lock.json docs: rework homepage and add aaif migration blog post (#8356) 2026-04-07 07:18:04 +00:00
package.json chore(deps): bump swiper from 11.2.10 to 12.1.2 in /documentation (#7368) 2026-03-02 09:08:57 -05:00
postcss.config.js Docs: Revamp extensions site (#1260) 2025-03-24 14:56:40 +01:00
README.md docs: clarify directory in /documentation readme (#6541) 2026-01-16 08:58:34 -08:00
sidebars.ts feat: V1.0 (#734) 2025-01-24 13:04:43 -08:00
tailwind.config.js Docs: Add Goose Recipes Cookbook Page (#2998) 2025-06-20 16:46:27 -04:00
tsconfig.json Prompt Library (#1906) 2025-03-31 07:29:37 -04:00

Website

This website is built using Docusaurus, a modern static website generator.

Run all commands from the documentation/ directory.

Installation

$ npm i

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.