goose/documentation
Lee-Si-Yoon c77f95b9c5
fix(providers): update FriendliAI provider name, description, and docs link (#13412)
Co-authored-by: Jack Amadeo <jackamadeo@squareup.com>
2026-11-20 14:33:00 +00:00
..
automation/gdk-api docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
blog docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
docs fix(providers): update FriendliAI provider name, description, and docs link (#13412) 2026-11-20 14:33:00 +00:00
plugins docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
scripts docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
src docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
static docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
.gitignore docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
.goosehints Add .goosehints file to enforce lowercase branding in documentation (#4870) 2025-09-28 23:53:56 -04:00
.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: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00:00
package-lock.json build(deps): bump minimatch and serve-handler in /documentation (#13452) 2026-11-12 06:22:13 +00:00
package.json docs: give GDK its own navigation and developer guides (#13165) 2026-10-29 21:29:35 +00: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 docs: rename GDK to oi-kit (#13345) 2026-11-19 23:11:13 +00: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.