stopplidelsen/innhold
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update AGENT.md with expanded documentation structure

Browse source
This commit is contained in:
Ruben 2026-02-06 19:15:21 +01:00
parent 631c784efc
commit 2f024e28be
1 changed files with 62 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

84
AGENT.md
View file

@ -1,37 +1,77 @@
## Philosophy # Stopp lidelsen - Site built on FolderWeb
Minimal PHP for modern conveniences. Prioritize longevity (decade-scale maintainability) by avoiding volatile dependencies. Strictly add only what's essential—readable, simple, and future-proof.
Advocacy site for medical cannabis patients in Norway. Built on FolderWeb (minimal file-based CMS).
## Edit instructions ## Edit instructions
All edits to this AGENT.md file should be done in a compressed shortform for LLM consumption. All edits to this AGENT.md file should be done in a compressed shortform for LLM consumption.
## Two Repos, One Site
- `app/` is a **symlink** to the FolderWeb framework (`folderweb/app`). **NEVER modify files in `app/`.**
- Only modify files in `custom/`, `content/`, and project root.
- Framework docs: read `app/docs/` when needed for understanding routing, hooks, templates, etc.
- Site-specific docs: read `docs/` in this repo for guidance on this site's features and customizations.
## Philosophy
Minimal PHP for modern conveniences. Decade-scale maintainability. No volatile dependencies. Only essential code.
## Core Constraints ## Core Constraints
**Minimalism:** Only essential tech (HTML, PHP 8.4+, CSS). No JS, frameworks, build tools, or package managers. Comments only for major sections. **Stack:** HTML5, PHP 8.4+, CSS. no frameworks, no build tools, no package managers.
**Frontend:** **Frontend:** Classless semantic HTML5. Modern CSS (nesting, `oklch()`, grid, `clamp()`, logical props). Responsive via fluid typography + flexible layouts. Comments only for major sections.
- Classless, semantic HTML5
- Modern CSS: nesting, `oklch()`, grid, `clamp()`, logical props
- Responsive via fluid typography + flexible layouts
**Security:** **Security:** Path traversal protection, document root restriction, strict MIME types, escape all UGC, CSV injection prevention.
- Path validation blocks traversal
- Files restricted to document root
- Strict MIME types + no direct user-input execution
## Code Style ## Code Style
**PHP:** Modern syntax (arrow functions, null coalescing, match). Type hints where practical. Ternary for simple conditionals. Single-purpose functions. **PHP:** Arrow functions, null coalescing, match. Type hints where practical. Single-purpose functions.
**CSS:** Variables, native nesting, grid. `clamp()` over `@media`. Relative units.
**Templates:** `<?= htmlspecialchars($var) ?>` for UGC. `<?= $content ?>` for pre-rendered HTML.
**CSS:** Variables, native nesting, grid layouts. `clamp()` over `@media`. Relative units > pixels. ## Project Structure
**Templates:** Escape output (`htmlspecialchars()` for UGC). Short echo tags (`<?= $var ?>`). ```
content/ # Site content (folders = URLs)
custom/
config.ini # Site config (languages, plugins)
templates/ # Template overrides (base, list, page, list-card-grid, list-faq, list-grid)
styles/ # CSS overrides
plugins/page/ # Page plugins (petition-form, newsletter-signup)
languages/ # Translation files (no.ini, en.ini)
data/ # Runtime data (petition CSVs, rate limits, SMTP logs)
vendor/ # PHPMailer.Lite
app/ -> symlink # FolderWeb framework (DO NOT EDIT)
docs/ # Site-specific LLM documentation
```
## Development Environment and workflow ## Key Features
The host does not have PHP, always use `podman compose` with the `compose.yaml` configuration when interacting with the app through CLI. Check localhost:4040 when you need to look at the development site to check your changes. **Content:** Folders = URLs. `metadata.ini` controls titles, slugs, menu order, templates, feeds.
**Languages:** Norwegian (default), English available. Language plugin via `[en]` sections in metadata.
**Templates:** base.php wraps all pages. List templates: list.php, list-card-grid.php, list-faq.php, list-grid.php. Selected via `page_template` in metadata.
**Atom feeds:** Enabled per-section via `feed = true` in metadata. URL: `/{section}/feed.xml`. Feed link auto-added to `<head>` when `$feedUrl` is set.
**Petition system:** GDPR-compliant, CSV-based, double opt-in email confirmation, file locking, rate limiting. See `docs/petition-system.md`.
**Newsletter:** Listmonk integration via public API. Hero and small themes. See `docs/newsletter-plugin.md`.
**LLM Agent Testing Protocol:** ## Knowledge Base
**Container isolation:** ALL test data (CSV, temp files, generated content) MUST remain inside container filesystem (not mounted volumes)
*Testing website:** `curl localhost:4040/path` to fetch pages, test forms with `curl -X POST -d "field=value" localhost:4040/path` Read these docs on-demand when working on related areas:
- **Test data paths:** Use `/tmp/` or `/var/test/` inside container—never write to `/var/www/html` or mounted dirs during tests
| Topic | File | Read When |
|---|---|---|
| Templates & variables | `docs/templates.md` | Modifying templates, understanding available variables |
| Content & metadata | `docs/content-system.md` | Adding/modifying content, metadata fields, feeds |
| Petition system | `docs/petition-system.md` | Modifying petition form, CSV format, email flow |
| Newsletter plugin | `docs/newsletter-plugin.md` | Modifying newsletter signup, Listmonk integration |
| Framework internals | `app/docs/` | Understanding routing, hooks, plugins, rendering pipeline |
## Development Environment
Host has no PHP. Always use `podman compose` with `compose.yaml`.
**Dev server:** `localhost:4040`
**Testing:** `curl localhost:4040/path` to fetch pages; `curl -X POST -d "field=value" localhost:4040/path` for forms
**Container isolation:** ALL test data (CSV, temp files) MUST stay inside container filesystem, never in mounted volumes
**Test data paths:** Use `/tmp/` or `/var/test/` inside container
**Running tests:** `podman exec stopplidelsen.no php /path/to/test.php` or `podman-compose run --rm custom php /tmp/test-script.php` **Running tests:** `podman exec stopplidelsen.no php /path/to/test.php` or `podman-compose run --rm custom php /tmp/test-script.php`
**Syntax checks:** `podman exec stopplidelsen.no php -l /var/www/custom/file.php` **Syntax checks:** `podman exec stopplidelsen.no php -l /var/www/custom/file.php`
**Cleanup:** `podman-compose down && podman-compose up -d` between test runs **Cleanup:** `podman-compose down && podman-compose up -d` between test runs