SirPepperPot Wiki — Cloudflare Pages deployment

The wiki is a static DocFX site. Conceptual Markdown and committed public API YAML are built together into _site.

Local validation

Use scripts/generate-api-public.ps1 whenever the Toolkit public surface or XML comments change. For conceptual-only edits, use scripts/build-local.ps1. Both builds treat DocFX warnings as errors.

Cloudflare Pages settings

  • Production branch: main
  • Root directory: repository root
  • Build command: bash scripts/cf-pages-build.sh
  • Build output directory: _site
  • Custom domain: wiki.sirpepperpot.com

No D1, R2, Worker binding, private Toolkit checkout, or game assembly is required. The build script installs .NET 8 only when the Cloudflare image does not already provide it, restores pinned DocFX 2.78.5, and builds the committed source.

API privacy boundary

Generate API YAML locally from release FTK2.ModAPI.dll plus its side-by-side XML documentation. Temporary resolver assemblies are deleted. Commit only Markdown, configuration, static assets, and generated YAML. Never commit _api-input, Toolkit source, DLLs, PDBs, game files, or private local paths.

Publishing

Pushing the prepared commit to the configured production branch triggers Cloudflare Pages. Confirm the Pages project still uses _site as its output and that wiki.sirpepperpot.com remains attached as the custom domain.