Workshop Bot
044a14be5e
Some checks failed
/ deploy (push) Has been cancelled
Scaffold (deploy workflow, AGENTS/CLAUDE/README) + full static mirror of cigvillage.ie: home, shop, product/category/tag pages, contact, blog. Dynamic commerce (cart/checkout/my-account/Stripe) is intentionally excluded — not functional on a static host.
73 lines
2.5 KiB
Markdown
73 lines
2.5 KiB
Markdown
# AGENTS.md — CIG Village 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 **CIG Village Ireland** website (cigvillage.ie) — originally a
|
|
WordPress + WooCommerce store. This repo is a **plain static snapshot**: HTML, CSS,
|
|
JavaScript and image assets with **no build step and no dependencies**. The files are
|
|
served to visitors *exactly as they are committed*.
|
|
|
|
The replica is served at **https://cigvillage.bcgen.ie**.
|
|
|
|
> **Note:** This is a *static* copy of a shop. Product and content pages render, but
|
|
> dynamic commerce (cart, checkout, my-account, Stripe payments) is **not** functional
|
|
> here — those depend on a WordPress/WooCommerce backend that this static host does not
|
|
> run. Treat this as a browseable archive/replica of the storefront.
|
|
|
|
## Repo map
|
|
|
|
| Path | What it is |
|
|
|------|------------|
|
|
| `index.html` | Home page |
|
|
| `shop/` | Shop listing |
|
|
| `product/` | Individual product pages |
|
|
| `product-category/`, `product-tag/` | Store taxonomy pages |
|
|
| `category/`, plus dated post folders | Blog / "goal updates" content |
|
|
| `contact-us/` | Contact page |
|
|
| `wp-content/` | Theme/plugin assets and uploaded images |
|
|
| `.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. `/wp-content/...`) resolve.
|
|
|
|
## The workflow (follow this every time)
|
|
|
|
### 1. Make changes on a branch
|
|
Never edit `main` directly:
|
|
|
|
```bash
|
|
git checkout main && git pull
|
|
git checkout -b describe-your-change
|
|
```
|
|
|
|
### 2. Preview locally before shipping
|
|
|
|
```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`
|
|
|
|
```bash
|
|
git add -A
|
|
git commit -m "Describe your change"
|
|
git push -u origin describe-your-change
|
|
```
|
|
Then open the PR targeting `main`.
|
|
|
|
### 4. Merge to publish
|
|
Merging into `main` triggers automatic deployment; the live site at
|
|
**https://cigvillage.bcgen.ie** updates within about a minute.
|
|
|
|
## Guardrails
|
|
|
|
- **Keep it dependency-free static HTML/CSS/JS.** No frameworks, bundlers, or build tools.
|
|
- **Never edit `.forgejo/`** or anything related to deployment/hosting.
|
|
- Keep new images under `wp-content/uploads/` (or `assets/`), prefer `.webp`, keep them
|
|
reasonably small.
|
|
- After editing, check that internal links and images still resolve in the local preview.
|