diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..5de4cdf7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,41 @@ +# AGENTS.md + +- [Architecture](#architecture) +- [Commits](#commits) +- [Pull Requests](#pull-requests) + +## Architecture + +This is a **MkDocs** project that can be run with `pip`, Poetry` or Docker. [Read more.](./README.md#developing) + +### Services + +| Service | Container | Port | +| --- | --- | --- | +| MkDocs | `designsafe_user_guide` | `localhost:8000` | + +### Make + +Use the `Makefile` instead of raw `docker compose` commands: + +| Command | Purpose | +| --- | --- | +| `make build` | Build Docker images | +| `make start` | Start containers (`ARGS="--detach"` for background) | +| `make stop` | Stop containers | + +### Lint, Test, Build + +- No linting software is configured. +- Every PR automatically gets a preview server via Netlify. + +## Commits + +- **Format:** `.gitmessage` (fallback: `~/.gitmessage`) + +## Pull Requests + +- **Title:** `.gitmessage` (fallback: `~/.gitmessage`) +- **Description:** `.github/PULL_REQUEST_TEMPLATE.md` + - Be concise: plain language, simple sentences; reviewers find detail in the diff. Say what changed, then why (if it matters) — never how. + - When updating, first re-read the current description, because it may have been edited. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..43c994c2 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/Makefile b/Makefile index 2c7fc776..4f8bfb39 100644 --- a/Makefile +++ b/Makefile @@ -18,8 +18,8 @@ build: .PHONY: start start: - $(DOCKER_COMPOSE_CMD) -f docker-compose.yml up + $(DOCKER_COMPOSE_CMD) -f ./docker-compose.yml up $(ARGS) .PHONY: stop stop: - $(DOCKER_COMPOSE_CMD) -f docker-compose.yml down + $(DOCKER_COMPOSE_CMD) -f ./docker-compose.yml down $(ARGS)