Skip to content

GitHub and Cloudflare Publishing

Updated: 2026-06-04

Operating model

This wiki uses the following flow:

  1. A person triggers a task in Slack
  2. The AI agent writes or updates markdown under ai-company/wiki/
  3. The app updates wiki/index.md and wiki/log.md
  4. The app can optionally commit and push those wiki files to GitHub
  5. Cloudflare Pages rebuilds from the GitHub repository
  6. People read the published result on Cloudflare

Source of truth

GitHub is the source of truth for published wiki content.

  • The editable files live in this repo
  • Cloudflare Pages should be connected to this GitHub repository
  • A successful push is what makes a wiki update eligible for deployment

Runtime behavior

The app supports three sync modes:

Mode Env Result
Local write only default Saves wiki files in the repo, but does not commit
Auto-commit GIT_AUTO_COMMIT=1 Saves and commits the affected wiki files
Auto-push GIT_AUTO_COMMIT=1, GIT_AUTO_PUSH=1 Saves, commits, and pushes to GitHub

Required paths

The Scout agent currently updates:

  • wiki/research/<slug>/notes.md
  • wiki/index.md
  • wiki/log.md
GIT_AUTO_COMMIT=1
GIT_AUTO_PUSH=1
GIT_PUSH_REMOTE=origin
GIT_PUSH_BRANCH=main

If the runtime cannot push using the repository's existing credentials, set:

GIT_PUSH_REMOTE_URL=https://x-access-token:<github_token>@github.com/<owner>/<repo>.git

Cloudflare Pages setup

Connect Cloudflare Pages to this GitHub repository and configure:

  • Root directory: /
  • Build command: pip install -r requirements-wiki.txt && mkdocs build --clean
  • Build output directory: site

After that, each pushed wiki change can become a new Cloudflare deployment.

Operational note

If Slack says the wiki was saved locally but not pushed, the content exists in the repo checkout but is not yet the published source of truth. In that case, Git sync settings or credentials need attention.