goose/documentation
Angie Jones 4617040c7b
Some checks failed
Canary / Prepare Version (push) Waiting to run
Canary / build-cli-linux (push) Blocked by required conditions
Canary / Upload Install Script (push) Waiting to run
Canary / bundle-macos-arm64 (push) Blocked by required conditions
Canary / bundle-macos-x64 (push) Blocked by required conditions
Canary / bundle-windows (push) Blocked by required conditions
Canary / bundle-windows-cuda (push) Blocked by required conditions
Canary / Release (push) Blocked by required conditions
CI / changes (push) Waiting to run
CI / Check goose-sdk UniFFI (push) Blocked by required conditions
CI / Test Kotlin GDK package (push) Blocked by required conditions
CI / Build and Test TLS Backend (native-tls) (push) Blocked by required conditions
CI / Build and Test TLS Backend (rustls-tls) (push) Blocked by required conditions
CI / Build and Test Roaming Feature (push) Blocked by required conditions
CI / Build Rust Project on Windows (push) Waiting to run
CI / Test Desktop Updater Install (ubuntu-latest) (push) Blocked by required conditions
CI / Test Desktop Updater Install (windows-latest) (push) Blocked by required conditions
CI / goose ACP npm packages (push) Blocked by required conditions
CI / Check Rust Code Format (push) Blocked by required conditions
CI / Build and Test Rust Project (push) Blocked by required conditions
CI / Build Lean ACP Binary (push) Blocked by required conditions
CI / Check and Test GDK Agent Crates on wasm32 (push) Blocked by required conditions
CI / Check MSRV (push) Blocked by required conditions
CI / Lint Rust Code (push) Blocked by required conditions
CI / Check Generated Schemas are Up-to-Date (push) Blocked by required conditions
CI / Check GDK Release Configuration (push) Waiting to run
CI / Check GDK API Reference is Up-to-Date (push) Waiting to run
CI / Test and Lint Electron Desktop App (push) Blocked by required conditions
MCP Conformance / Build Conformance Binaries (push) Waiting to run
MCP Conformance / Conformance 2025-11-25 / 0.1.16 (push) Blocked by required conditions
MCP Conformance / Conformance 2025-11-25 / 0.2.0-alpha.10 (push) Blocked by required conditions
MCP Conformance / Conformance 2026-07-28 / 0.2.0-alpha.10 (push) Blocked by required conditions
Create Minor Release PR / check-version-bump-pr (push) Waiting to run
Create Minor Release PR / release (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 (Code Execution) (push) Blocked by required conditions
Publish Ask AI Bot Docker Image / docker (push) Waiting to run
Publish Docker Image / docker (push) Waiting to run
Scorecard supply-chain security / Scorecard analysis (push) Waiting to run
Live Provider Tests / Smoke Tests (push) Blocked by required conditions
Live Provider Tests / Compaction Tests (push) Blocked by required conditions
Unused Dependencies / machete (push) Has been cancelled
Deploy Documentation / deploy (push) Has been cancelled
Prepare GDK release / Create or update GDK release PR (push) Has been cancelled
Update homepage stats (#12848)
2026-10-12 03:25:48 +00:00
..
automation feat(gdk): let Kotlin callers configure the Databricks AI Gateway path (#11631) 2026-09-02 19:46:33 +00:00
blog docs: Agentic State Machines (#12130) 2026-10-08 23:24:54 +00:00
docs feat(compaction): cap auto-compaction at 225k tokens by default (#12790) 2026-10-09 09:04:40 +00:00
plugins [docs] Add OSS Skills Marketplace (#6752) 2026-01-28 22:46:18 -05:00
scripts doc (acp): move acp reference under GDK section (#11805) 2026-09-03 03:56:32 +00:00
src Update homepage stats (#12848) 2026-10-12 03:25:48 +00:00
static docs: Agentic State Machines (#12130) 2026-10-08 23:24:54 +00:00
.gitignore [docs] Add OSS Skills Marketplace (#6752) 2026-01-28 22:46:18 -05:00
.goosehints
.npmrc
AGENTS.md Clarify extension directory policy (#11923) 2026-09-10 18:49:07 +00:00
CLAUDE.md agents: add CLAUDE.mds to mirror AGENTS.mds (#9029) 2026-05-05 18:53:52 +00:00
docusaurus.config.ts docs: remove Rube extension, service discontinued (#12116) 2026-09-16 15:54:20 +00:00
package-lock.json docs: remove Inkeep search integration (#12085) 2026-09-15 19:15:46 +00:00
package.json docs: remove Inkeep search integration (#12085) 2026-09-15 19:15:46 +00:00
postcss.config.js
README.md docs: clarify directory in /documentation readme (#6541) 2026-01-16 08:58:34 -08:00
sidebars.ts
tailwind.config.js
tsconfig.json

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.