Scaffold: deploy workflow, AGENTS/CLAUDE/README
Some checks are pending
/ deploy (push) Waiting to run

This commit is contained in:
Workshop Bot 2026-06-09 20:29:57 +00:00
parent 6774148618
commit 65dfd25236
4 changed files with 114 additions and 1 deletions

74
AGENTS.md Normal file
View file

@ -0,0 +1,74 @@
# AGENTS.md — Family Fed Ireland website
This file tells any AI coding assistant how to work on this website. Read it before
making changes.
## What this is
A static replica of the **Family Fed Ireland** website (familyfed.ie). It is a
**plain static site**: HTML, CSS, JavaScript and image assets with **no build step
and no dependencies**. The files in this repo are served to visitors *exactly as they
are committed* — what you see locally is what goes live.
The replica is served at **https://familyfed.bcgen.ie**.
## Repo map
| Path | What it is |
|------|------------|
| `index.html` | Home page |
| `*.html` | Top-level pages |
| `css/` | Stylesheets |
| `js/` | Page JavaScript |
| `assets/` | Images, fonts, and other static assets |
| `.forgejo/` | **Deploy automation — do not touch** (see "Guardrails") |
Preview through a local web server, not by opening the `.html` file directly, so
that absolute links (e.g. `/css/style.css`) resolve.
## The workflow (follow this every time)
### 1. Make changes on a branch
Never edit `main` directly. Start from an up-to-date `main` and create a branch:
```bash
git checkout main && git pull
git checkout -b describe-your-change
```
### 2. Preview locally before shipping
From the repo root, start a local server and open it in a browser:
```bash
python3 -m http.server 8000
# then open http://localhost:8000
```
Visually check every page you touched. **Do not ship a change you have not previewed.**
### 3. Open a pull request into `main`
When it looks right, commit, push the branch, and open a PR targeting `main`:
```bash
git add -A
git commit -m "Describe your change"
git push -u origin describe-your-change
```
### 4. Merge to publish
Merging the PR into `main` triggers automatic deployment. The live site at
**https://familyfed.bcgen.ie** updates within about a minute. There is nothing else
to run or deploy.
## Guardrails
- **Keep it dependency-free static HTML/CSS/JS.** No frameworks, bundlers, or build
tools — anything added to the repo is served raw.
- **Never edit `.forgejo/`** or anything related to deployment/hosting. That is managed
separately; changing it can break publishing.
- Keep new images in `assets/`, prefer modern formats (`.webp`/`.avif`) where possible,
and keep them reasonably small so pages load fast.
- After editing, check that internal links and images still resolve (you'll catch this
in the local preview).
- Match the existing style and reuse the classes already defined under `css/` rather
than inventing new patterns.