47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# AGENTS.md - Family Fed Ireland website
|
|
|
|
This repository is for local work only. Do not treat it as a live production
|
|
server, and do not avoid changes because of live URL concerns unless the user
|
|
explicitly says a change must preserve a URL.
|
|
|
|
## What This Is
|
|
|
|
This is a plain static website made from HTML, CSS, JavaScript, images, PDFs,
|
|
and other static assets.
|
|
|
|
## Working Rules
|
|
|
|
- All files in this repository may be changed when needed.
|
|
- When the user says to move something, move it. Do not only copy it or create a
|
|
parallel structure unless the user specifically asks for a copy.
|
|
- If moving files requires updating links, imports, scripts, stylesheets, image
|
|
paths, or documentation, update those references too.
|
|
- Keep the structure simple and close to what the user asks for.
|
|
- `.forgejo/` and deployment configuration are not special unless the user says
|
|
they are.
|
|
|
|
## Repo Map
|
|
|
|
| Path | What it is |
|
|
|------|------------|
|
|
| `website/index.html` | Home page |
|
|
| `website/about.html` | About page |
|
|
| `website/contact.html` | Contact page with the form |
|
|
| `website/*.html` | All other static pages, archives, categories, tags, and posts |
|
|
| `website/PAGES.md` | Map from old folder paths to new flat filenames |
|
|
| `css/` | Site-level stylesheets |
|
|
| `js/` | Site-level scripts |
|
|
| `assets/` | Images, PDFs, fonts, theme files, uploads, and static vendor files |
|
|
| `docs/` | Maintainer notes and site-structure documentation |
|
|
|
|
## Local Preview
|
|
|
|
```bash
|
|
docker compose up
|
|
```
|
|
|
|
Then open:
|
|
|
|
```text
|
|
http://localhost:8080/
|
|
```
|