Files
xamxam/docs
..
2026-04-13 11:12:12 +02:00
2026-04-13 11:12:12 +02:00
2026-04-13 11:12:12 +02:00

Documentation index

This directory mixes current reference docs, proposals/plans, and historical/archived analysis. Use this index to find the right document.

Note on naming: XAMXAM was previously Post-ERG (and the code was once organised under posterg-website/, apps/, front-backend/, /var/www/posterg/). References to posterg, apps/public/inc/header.php, posterg.db, just serve, php-live-reload, tests/run-tests.php, etc. in historical docs reflect 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.

Current reference (kept up to date)

Doc Contents
development.md Dev workflow, structure, builds, testing, linting
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
import.md CSV import format + behaviour
security.md Current security posture
file-uploads.md Upload surfaces, types, storage layout
CSS.md CSS architecture + build
bookmarklet.md Form auto-fill test helper

Proposals / plans (proposed, not all implemented)

Doc Status
LDAP_AUTH_PLAN.md + LDAP_SPEC.md LDAP login — not implemented
monolog-plan.md Single Monolog logger replacing AppLogger/AdminLogger/ErrorHandler/Audit — plan
de-librairisation.md Replace bespoke SMTP/Markdown/HTTP/crypto with libraries (partly done)
refactoring.md Older refactoring proposal
ANALYSIS_STRUCTURE_REORG.md Proposed structure reorg
ANALYSIS_INLINE_JS_CSS_MINIFY.md Inline JS/CSS/minify analysis (largely actioned by the build system)
backup-plan.md Backup plan — largely implemented (see deployment.md)
repertoire-mobile-propositions.md Mobile repertoire UI proposals
cms-migration-plan.html CMS migration plan
spec-sheet.md Original requirements fiche technique
Proposition procédure licences_V2.pdf Licence procedure proposal (filename contains non-ASCII/combining chars)

Historical / archived (kept for context — may reference the old codebase)

Doc Contents
LIVRAISONS_PAR_MOIS.md Monthly delivery log grouped by functional family
migration-history.md History of major structural migrations
CURRENT_ISSUES.md Issue log (2026-05-10) — many since resolved
IMMEDIATE_FIX.md One-off fix note
EVIDENCE_SUMMARY.md + VM_Crash_*.md VM crash investigation (concluded: not the app)
css.md Old Bulma-removal writeup (pre-dates current build system; see CSS.md)
php-vs-flask.md Language choice decision
orm-assessment.md ORM evaluation
system-setup.md Old setup notes
SETUP.md, SPECS.md, TODO.md Earlier setup/spec/todo snapshots
SMTP_550_POSTFIX_FIX.md SMTP troubleshooting record
testing.md PHP testing best-practices writeup
test-plan.md Manual test plan
autosave-system.md, filepond-crash-analysis.md, filepond-race-investigation.md Feature/issue deep-dives (status noted in each file)
pi-session-2026-05-10T*.html Captured session log
ANALYSIS_INLINE_JS_CSS_MINIFY.md (see proposals)
bookmarklet.md (kept current — see above)
  • 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 current reference doc in the table above. Leave historical docs untouched (they are read-only context). Move newly-written analysis into the appropriate section.