Skip to content

Document Makefile usage in AGENTS.md - #232

Open
jerryzhou196 wants to merge 1 commit into
mainfrom
makefile-docs
Open

Document Makefile usage in AGENTS.md#232
jerryzhou196 wants to merge 1 commit into
mainfrom
makefile-docs

Conversation

@jerryzhou196

Copy link
Copy Markdown
Member

Summary

Adds a Using the Makefile section to uwflow/AGENTS.md, below the existing @README.md import, so agents (and humans) have the make targets documented in one place.

Content is derived directly from the targets in uwflow/Makefile:

  • The include .env prerequisite, and the dev-override vs. public-image compose configurations
  • Setup: setup, setup-contrib, import-profs
  • Services: start, start-public, stop, ps, clean — with a callout that clean destroys the Postgres volume
  • Logs: logs and the per-service variants
  • Importer jobs: import-course / import-vacuum, noting the importer does not live-reload and each target rebuilds uw first
  • Hasura: migrate / migrate-status, with the hasura CLI and HASURA_GRAPHQL_ADMIN_SECRET requirements
  • Tests: test, build-test, docker-build-test — noting the first two docker exec into a running api container

Test plan

Documentation only; no code changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_0128PtjYLJ5ohoJgbyuJeZrP

Describe every make target grouped by workflow (setup, running services,
logs, importer jobs, Hasura migrations, tests), along with the .env
prerequisite and the caveats that `clean` destroys the Postgres volume and
that the test targets need a running api container.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0128PtjYLJ5ohoJgbyuJeZrP
@jerryzhou196
jerryzhou196 requested a review from AD1938 September 8, 2026 17:09
@jerryzhou196
jerryzhou196 marked this pull request as ready for review September 8, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant