docs: CLAUDE.md light expansion (repo purpose, deploy contract, pointers)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PSK5g6qYLknKj8u3QAFEr6
This commit is contained in:
@@ -1,34 +1,12 @@
|
||||
# REPORT — docs: REUSE.md introduced (cross-repo reuse map)
|
||||
# REPORT — docs: CLAUDE.md light expansion
|
||||
|
||||
**Date:** 2026-07-03 · **Class:** docs-only (no template change, no deploy effect)
|
||||
**Baseline:** `main` @ `bb81cd414afcb89e28ac60f405133f40195e6c43`
|
||||
**Date:** 2026-07-03 · **Class:** docs-only (no template changes, no deploy effect)
|
||||
**Baseline:** `main` @ `c5a3d1b15b` (unchanged)
|
||||
|
||||
## What was done
|
||||
The minimal REUSE-rollout CLAUDE.md stub expanded (diffstat: +26/−5, ~30 lines total): repo purpose
|
||||
(one dir per app, `docker-compose.yml` + `.felhom.yml`, Hungarian customer text), the push-to-main =
|
||||
deploy contract (controller git-sync ≤15 min, manual trigger via "Sablonok frissítése" /
|
||||
`POST /api/sync`, `app.yaml` never overwritten), the legacy `templates.json` warning, and pointers
|
||||
(REUSE.md conventions, README format spec, `felhom-build-deploy` skill).
|
||||
|
||||
- **`REUSE.md`** created at the repo root (58 lines, light §2/§5-focused variant per spec):
|
||||
the canonical example app (**paperless-ngx** — copy its structure), `.felhom.yml` required-field
|
||||
set (verified across all 53 apps), deploy_fields conventions, the five Docker-healthcheck families
|
||||
(BusyBox wget / curl / Node / Python / DB sidecars) each with a cited example, the memory
|
||||
request/limit convention (`mem_limit` = sum of compose limits; limits enforced, no reservations),
|
||||
the new-app checklist, and traps (gokapi entrypoint hack; legacy `templates.json` +
|
||||
`scripts/generate-customer.sh`; uptime-kuma's image-specific healthcheck binary).
|
||||
- **`CLAUDE.md`** created (minimal — this repo had none): the REUSE.md pointer + same-commit
|
||||
maintenance rule + the workspace CHANGELOG/REPORT convention. A full CLAUDE.md is a separate task.
|
||||
- `CHANGELOG.md` entry + `CONTEXT.md` created (one-liner).
|
||||
|
||||
## Verification
|
||||
|
||||
`python felhom.eu/scripts/reuse_refs_check.py e:/git/app-catalog-felhom.eu` →
|
||||
`OK [app-catalog-felhom.eu]: 10 cited paths, all exist`. Sweep: 53 apps scanned (all 53 descriptors
|
||||
share the same top-level key set; optional extras verified per file).
|
||||
|
||||
## Observations (NOT acted on) — README drift, recorded in REUSE.md §6
|
||||
|
||||
- README lists `templates/filebrowser/` (doesn't exist); omits `templates/recipe-importer/` (does).
|
||||
- README field-type table omits `subdomain` (all 53 apps use it) and `secret_input` (romm); lists
|
||||
`boolean` which nothing uses.
|
||||
- README says smtp_mapping = "Vaultwarden, Mealie"; six apps carry it (calcom, gitea, mealie,
|
||||
nextcloud, rallly, vaultwarden).
|
||||
- Healthcheck URL style drift (localhost vs 127.0.0.1, `curl -f` vs `-sf`, two Node one-liner styles).
|
||||
|
||||
Cross-repo summary + full sweep counts: `felhom.eu/REPORT.md`.
|
||||
Consolidated cross-repo report: `felhom.eu/REPORT.md`.
|
||||
|
||||
Reference in New Issue
Block a user