Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading