Skip to main content
Version: Alpha

Develop Golf

Provider and source authority

This portable contract describes its linked source snapshot. For current deployment instructions, use current installation, authentication and native Cloudflare guides. Historical receipts do not verify later builds.

The product, marketing website and documentation are independent repositories:

No CI workflows are configured yet. Run checks locally and record evidence.

# Documentation repository
npm ci
npm run check
npm run llms
npm run build
npm run check:build

Current Markdown lives in docs/; MDX is available for useful embedded components. Do not describe planned features as shipped. Do not invent version snapshots just to fill the selector.

For the application, follow its README and AGENTS.md. Keep AI and Cloudflare optional for the portable core. Use supported Forgejo APIs rather than internal database writes.

For a product contract change, edit api/golf/v1/golf.proto, run make generate, then run make generate-check and the applicable server/CLI/browser checks. The product pins Buf, Protobuf/Connect generators and SQLC. Never hand-edit generated clients, create a parallel REST model or infer a stable release from the schema's v1 package name. Update the API and CLI guides with the actual generated field and presence rules.