xamxam/docs/README.md

Documentation index

docs/ holds current reference documentation describing how the system actually works today. Everything else — proposals, plans, incident reports, analyses, original requirements, one-off helpers — is in archive/.

Note on naming: XAMXAM was previously Post-ERG (code once organised under posterg-website/, apps/, front-backend/, /var/www/posterg/). Historical docs may reference the old layout; the live paths are now app/, app/public/, app/storage/xamxam.db, just dev, PHPUnit, and /var/www/xamxam/ on the server.

Reference docs

Doc	Contents
development.md	Dev workflow, structure, builds, testing, linting
environment.md	Runtime stack, PHP/nginx/DB/Node requirements, server specs
deployment.md	Server setup, deploy, backups, rollback
database.md	SQLite schema, migrations, tables, common ops
search.md	/search and /repertoire behaviour
export.md	CSV / DB / files export + full restore procedure
nextcloud-sync.md	Off-site SQLite snapshot sync to Nextcloud WebDAV
import.md	CSV import format + behaviour
security.md	Current security posture
file-uploads.md	Upload surfaces, types, storage layout
CSS.md	CSS architecture + build

Archive

Non-documentation material (proposals, plans, incident reports, analyses, requirements, one-off helpers) is preserved read-only in archive/ for context. It is not maintained.

Related documentation elsewhere

• nginx/docs/ — nginx config, security headers, deployment, HTACCESS→nginx
• app/storage/README.md — DB quick-reference (schema link)
• app/public/admin/README.md — admin panel structure

---

Maintenance guidance: when updating code, update the matching reference doc above. Do not move analysis/proposals into docs/ — put them in archive/.