Developer Guide

Project commands

uv sync
uv run pytest
uv run ruff check .
uv run basedpyright

Documentation site

The canonical public site is loops.artificalgarden.org.

The docs site uses MkDocs Material and is intended for Cloudflare Pages.

Build locally:

uv run --group docs mkdocs build --site-dir site

Serve locally:

uv run --group docs mkdocs serve

Cloudflare Pages settings:

Setting	Value
Project name	loopspec-workflow
Production domain	loops.artificalgarden.org
Build command	uv run --group docs mkdocs build --site-dir site
Build output directory	site

The repository also includes wrangler.jsonc with pages_build_output_dir set to ./site.

Direct deploy option

After building locally, deploy the site/ directory with Wrangler:

npx wrangler pages deploy site --project-name loopspec-workflow --branch main

Attach the custom domain in Cloudflare Pages: Workers & Pages -> loopspec-workflow -> Custom domains -> Set up a custom domain -> loops.artificalgarden.org.

Source docs

• docs/index.md: homepage.
• docs/user-guide.md: user-facing launch guide.
• docs/developer-guide.md: maintainer and deployment guide.
• docs/quick-reference.md: compact command/spec reference.