diff --git a/AGENTS.md b/AGENTS.md index c959d51f..9073ed45 100644 --- a/AGENTS.md +++ b/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. diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index b5911b32..00000000 --- a/CLAUDE.md +++ /dev/null @@ -1,2 +0,0 @@ -See [AGENTS.md](./AGENTS.md) for how to work on this website (repo layout, local -preview, and the branch → PR → merge-to-publish workflow). diff --git a/docs/MAINTENANCE.md b/docs/MAINTENANCE.md deleted file mode 100644 index 019c5b19..00000000 --- a/docs/MAINTENANCE.md +++ /dev/null @@ -1,50 +0,0 @@ -# Maintenance guide - -Use this guide when making regular content changes to the live static site. - -## Safe change workflow - -1. Start from an up-to-date `main`. -2. Create a branch. -3. Edit the smallest set of files needed. -4. Start a local server from the repo root: - - ```bash - docker compose up - ``` - -5. Preview each changed page at `http://localhost:8080/`. -6. Check that images, internal links, and forms still behave as expected. -7. Commit, push, and open a PR into `main`. - -## What to edit first - -For a maintained public website, prioritize these pages: - -- `index.html` -- `about-us/index.html` -- `contact/index.html` -- `events/index.html` -- `services/index.html` -- `videos/index.html` - -These are the most visitor-facing pages. Archive pages can be improved later -unless they contain broken links or outdated information that visitors rely on. - -## What to avoid - -- Do not rename public route folders without a redirect plan. -- Do not edit `.forgejo/` for content or design changes. -- Do not add build tools, package managers, or framework dependencies. -- Do not delete legacy-looking assets just because they look unused. Verify - references first with `rg` and a browser preview. - -## Suggested cleanup order - -1. Confirm contact details, service times, and current event information. -2. Check the core pages on desktop and mobile. -3. Fix broken internal links and missing images. -4. Remove or adjust forms that cannot submit on a static site. -5. Clean duplicated export metadata only after confirming pages render the same. -6. Later, consider a tiny static templating workflow if shared navigation/footer - edits become frequent. diff --git a/docs/SITE-STRUCTURE.md b/docs/SITE-STRUCTURE.md deleted file mode 100644 index d034aa0f..00000000 --- a/docs/SITE-STRUCTURE.md +++ /dev/null @@ -1,54 +0,0 @@ -# Site structure - -This repository is the production source for `https://familyfed.bcgen.ie/`. -Everything is served as static files, so top-level page folders are also URL -paths. - -## Do not casually move these - -These top-level directories are public routes. Renaming or moving them changes -the live URL unless redirects are added at the hosting layer. - -- `about-us/` -- `contact/` -- `events/` -- `register/` -- `services/` -- `the-founders/` -- `videos/` -- `2013-sunday-service-archive/` through `2018-sunday-service-archive/` compatibility redirects -- `blog/` - -## Main content groups - -| Group | Paths | Notes | -| --- | --- | --- | -| Core pages | `index.html`, `about-us/`, `contact/`, `events/`, `register/`, `services/`, `the-founders/`, `videos/` | Best first targets for active maintenance. | -| Sunday service archives | `archive/sunday-services/YYYY/`, plus `services/` | Mostly link lists to Vimeo or YouTube. Old top-level year folders are redirect stubs only. | -| Speeches archive | `archive/speeches/`, `archive/speeches/rev-dr-sun-myung-moon/YYYY/` | Large historical text archive. Old top-level speech folders are not kept. | -| Blog mirror | `blog/` | Generated archive, category, tag, and dated pages. | -| Static assets | `assets/` | CSS, JavaScript, fonts, images, PDFs, and static vendor files. | - -## Asset locations - -- Site theme CSS, JavaScript, fonts, and images live under `assets/theme/parabola/`. -- Shared page/content CSS lives under `assets/css/`. -- General JavaScript lives under `assets/js/`. -- Uploaded images and PDFs live under `assets/uploads/`. -- Static vendor files used by old exported pages live under `assets/vendor/`. - -For new production images or PDFs, prefer adding them under -`assets/uploads/YYYY/MM/`. - -## Maintenance notes - -- Use a local web server when previewing: `docker compose up`. -- Check pages at `http://localhost:8080/...`, not by opening files directly. -- Keep edits small and URL-aware. -- Keep real archive pages under `archive/`. - The old top-level Sunday service folders are kept only so old links redirect - instead of breaking. Old top-level speech folders have been removed. -- When editing shared header, navigation, or footer markup, remember that the - markup is duplicated across many HTML files. -- Some legacy class names remain in exported markup and CSS. Treat them as static - styling hooks, not as a CMS dependency.