From cd4b824b00594f619467cef3b462891c563b5450 Mon Sep 17 00:00:00 2001 From: Loyyd Date: Wed, 10 Jun 2026 20:23:11 +0200 Subject: [PATCH] what this is --- AGENTS.md | 12 ++++++---- README.md | 22 +++++++++++++++-- docs/MAINTENANCE.md | 50 ++++++++++++++++++++++++++++++++++++++ docs/SITE-STRUCTURE.md | 54 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 132 insertions(+), 6 deletions(-) create mode 100644 docs/MAINTENANCE.md create mode 100644 docs/SITE-STRUCTURE.md diff --git a/AGENTS.md b/AGENTS.md index 71e29204..3f553533 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -17,12 +17,16 @@ The replica is served at **https://familyfed.bcgen.ie**. | Path | What it is | |------|------------| | `index.html` | Home page | -| `*.html` | Top-level pages | -| `css/` | Stylesheets | -| `js/` | Page JavaScript | -| `assets/` | Images, fonts, and other static assets | +| `*/index.html` | Public pages and archives; folder names are live URL paths | +| `blog/` | Mirrored blog archive, category, tag, and dated pages | +| `wp-content/` | WordPress-style theme, plugin, upload, font, image, CSS, and JS assets | +| `wp-includes/`, `wp/`, `cdn-cgi/` | Legacy static support paths referenced by the exported pages | +| `docs/` | Maintainer notes and site-structure documentation | | `.forgejo/` | **Deploy automation — do not touch** (see "Guardrails") | +Treat top-level content folders as production URLs. Do not move or rename them +unless redirects are planned outside this repo. + Preview through a local web server, not by opening the `.html` file directly, so that absolute links (e.g. `/css/style.css`) resolve. diff --git a/README.md b/README.md index ed519372..3927f174 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,29 @@ HTML/CSS/JS, served exactly as committed. Live at **https://familyfed.bcgen.ie**. +## Project structure + +This site is maintained as static HTML, but many paths still mirror the original +WordPress export. Top-level folders such as `about-us/`, `events/`, `services/`, +and `2013-sunday-service-archive/` are public URLs, so do not move or rename them +without also planning redirects. + +- `index.html` — home page +- `*/index.html` — public pages and archives +- `blog/` — mirrored blog archive pages +- `wp-content/` — theme files, plugin assets, fonts, images, and uploads used by + the exported pages +- `wp-includes/` and `cdn-cgi/` — legacy static support files referenced by pages +- `wp/` — legacy uploaded media path kept for compatibility +- `docs/` — maintainer notes and structure guides +- `.forgejo/` — deploy automation, do not edit during content work + ## Editing & deploy Plain static files, no build step. Edit on a branch, **preview locally** (`python3 -m http.server 8000` → http://localhost:8000), open a PR into `main`, and merge — merging `main` auto-deploys to the live site within ~1 minute. -See **[AGENTS.md](./AGENTS.md)** for the full workflow and repo layout (also read by -AI coding assistants). +See **[AGENTS.md](./AGENTS.md)** for the full workflow and +**[docs/SITE-STRUCTURE.md](./docs/SITE-STRUCTURE.md)** for a maintainer-oriented +map of what lives where. diff --git a/docs/MAINTENANCE.md b/docs/MAINTENANCE.md new file mode 100644 index 00000000..9c586e00 --- /dev/null +++ b/docs/MAINTENANCE.md @@ -0,0 +1,50 @@ +# 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 + python3 -m http.server 8000 + ``` + +5. Preview each changed page at `http://localhost:8000/`. +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 WordPress-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 WordPress 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 new file mode 100644 index 00000000..9f0c975e --- /dev/null +++ b/docs/SITE-STRUCTURE.md @@ -0,0 +1,54 @@ +# Site structure + +This repository is the production source for `https://familyfed.bcgen.ie/`. +Everything is served as static files, so file paths 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/` +- `speeches/` +- `the-founders/` +- `videos/` +- `2013-sunday-service-archive/` through `2018-sunday-service-archive/` +- `speeches-by-rev-dr-sun-myung-moon*/` +- `speeches-of-rev-sun-myung-moon-1995/` +- `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 | `2013-sunday-service-archive/` to `2018-sunday-service-archive/`, plus `services/` | Mostly link lists to Vimeo or YouTube. | +| Speeches archive | `speeches/`, `speeches-by-rev-dr-sun-myung-moon*/`, `speeches-of-rev-sun-myung-moon-1995/` | Large historical text archive. | +| Blog mirror | `blog/` | Generated archive, category, tag, and dated pages. | +| WordPress-style assets | `wp-content/`, `wp-includes/`, `wp/`, `cdn-cgi/` | Static leftovers from the original WordPress export. Keep paths stable while pages still reference them. | + +## Asset locations + +- Theme CSS, JavaScript, fonts, and images live under `wp-content/themes/parabola/`. +- Plugin CSS and JavaScript live under `wp-content/plugins/`. +- Uploaded images and PDFs live under `wp-content/uploads/` and `wp/wp-content/uploads/`. +- Cloudflare email decoding support lives under `cdn-cgi/`. + +For new production images or PDFs, prefer adding them under `wp-content/uploads/YYYY/MM/` +until the site has a cleaner asset convention. That keeps the project consistent +with the current exported pages. + +## Maintenance notes + +- Use a local web server when previewing: `python3 -m http.server 8000`. +- Check pages at `http://localhost:8000/...`, not by opening files directly. +- Keep edits small and URL-aware. +- When editing shared header, navigation, or footer markup, remember that the + markup is duplicated across many HTML files. +- Leftover WordPress endpoints such as `/wp-json/`, `/xmlrpc.php`, and + `/wp-admin/admin-ajax.php` appear in exported markup. They are not live backend + features in this static repo.