reviewGOOSE Documentation

Documentation site built with MkDocs Material.

Prerequisites

make install  # Creates Python virtual environment and installs mkdocs-material

The install command automatically:

• Creates a .venv directory with an isolated Python environment
• Installs all required dependencies
• Works on macOS, Linux, and Windows (with minor adjustments)

Quick Start

make run      # Starts local dev server at http://localhost:8000

Build & Deploy

make build   # Creates site/ directory
make clean   # Remove site/ directory

GitHub Pages (default):

• Automatic deployment on push to main via GitHub Actions
• Manual: make deploy

Cloudflare Pages (alternative): make deploy-cloudflare

Structure

docs/
├── mkdocs.yml
├── README.md
└── docs/
    ├── index.md           # Overview
    ├── getting-started.md # Installation
    ├── dashboard.md       # Web dashboard
    ├── slack.md           # Slack integration
    ├── goose.md           # Desktop app
    ├── github-bot.md      # GitHub App
    ├── plans.md           # Plan comparison
    ├── troubleshooting.md # Common issues
    └── security.md        # Security & privacy

Writing Style

Pike's rules:

• Commands over explanation
• No repetition
• Assume basic competence
• Cut obvious warnings
• Brevity is paramount

Structure pages naturally:

• Installation → Configuration → Troubleshooting
• No forced templates
• Let each page breathe

Deploy

Pushes to main automatically deploy via GitHub Actions.

Manual deploy:

make deploy  # GitHub Pages (default)

Custom domain: Add CNAME to docs/, configure DNS in GitHub Pages settings.