This commit is contained in:
parent
9fee73fd96
commit
fe208b0a77
4 changed files with 19 additions and 161 deletions
74
AGENTS.md
74
AGENTS.md
|
|
@ -1,77 +1,41 @@
|
|||
# AGENTS.md — Family Fed Ireland website
|
||||
# AGENTS.md - Family Fed Ireland website
|
||||
|
||||
This file tells any AI coding assistant how to work on this website. Read it before
|
||||
making changes.
|
||||
This is Family Fed Ireland website, served at:
|
||||
|
||||
## What this is
|
||||
https://familyfed.bcgen.ie
|
||||
|
||||
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.
|
||||
Work on it as a live production static site
|
||||
|
||||
The replica is served at **https://familyfed.bcgen.ie**.
|
||||
## What This Is
|
||||
|
||||
## Repo map
|
||||
This is a plain static website made from HTML, CSS, JavaScript, images, PDFs, and
|
||||
other static assets
|
||||
|
||||
## Repo Map
|
||||
|
||||
| Path | What it is |
|
||||
|------|------------|
|
||||
| `index.html` | Home page |
|
||||
| `*/index.html` | Public pages and archives; folder names are live URL paths |
|
||||
| `blog/` | Mirrored blog archive, category, tag, and dated pages |
|
||||
| `*/index.html` | Public pages; folder names are live URL paths |
|
||||
| `blog/` | Blog archive, category, tag, and dated pages |
|
||||
| `assets/` | CSS, JavaScript, fonts, images, PDFs, and static vendor files |
|
||||
| `docs/` | Maintainer notes and site-structure documentation |
|
||||
| `.forgejo/` | **Deploy automation — do not touch** (see "Guardrails") |
|
||||
| `.forgejo/` | Deploy automation - do not edit |
|
||||
|
||||
Treat top-level content folders as production URLs. Do not move or rename them
|
||||
unless redirects are planned outside this repo.
|
||||
## Keep It Simple
|
||||
|
||||
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
|
||||
docker compose up
|
||||
# then open http://localhost:8080
|
||||
```
|
||||
|
||||
Visually check every page you touched. **Do not ship a change you have not previewed.**
|
||||
Then open:
|
||||
|
||||
### 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
|
||||
```text
|
||||
http://localhost:8080
|
||||
```
|
||||
|
||||
### 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.
|
||||
## Deployment
|
||||
|
||||
## 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.
|
||||
Merging changes to `main` publishes the live site automatically. Do not edit
|
||||
`.forgejo/` or deployment configuration unless specifically asked.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue