This is a MkDocs project that can be run with pip, Poetry` or Docker. Read more.
| Service | Container | Port |
|---|---|---|
| MkDocs | designsafe_user_guide |
localhost:8000 |
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 |
- No linting software is configured.
- Every PR automatically gets a preview server via Netlify.
- Format:
.gitmessage(fallback:~/.gitmessage)
- 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.