docs: reconcile documentation against the code; add a supersession ledger
Five weeks of undocumented evolution left the docs describing a site that
partly no longer exists, with nothing marking which documents were historical.
The code is treated as the source of truth throughout; every claim below was
verified against code, config or the Makefile rather than inferred.
Two mechanisms, following patterns the repo already used:
- docs/reference/superseded-decisions.md (new) — one authoritative table of all
14 reversals: what was planned, where, what is true now, when, and why. Plus
a short list of decisions that were NOT reversed, since their planning docs
are old enough to look suspect.
- Inline "> **Superseded ...**" notes at each stale claim, so a claim can never
be read un-corrected. This mirrors the existing "> History:" notes in
architecture.md and "> **Changed 2026-07:**" in trip-switching.md.
Scope split by tense: present-tense docs (CLAUDE.md, reference/, guides/,
README.md, CONCEPTS.md) are corrected; past-tense records (plans/, specs/,
milestones/, summary.md, pm-analysis.md) are annotated only, never rewritten —
their staleness is what makes them records.
Present-tense corrections:
- CLAUDE.md asserted css-compiled/ is generated from css/style.css and
css/tokens.css. That source relationship does not exist: css/ is hand-authored
and served directly via assets.addCss in partials/base.html.twig, while
css-compiled/ is esbuild output from the CSS imports inside js/src/*.js.
Highest-severity finding — an always-loaded file inviting a hand-edit of a
generated bundle.
- README.md documented every remote-* target without the -test/-prod suffix
guard-env requires, so its entire server runbook was unrunnable, and listed
7 of ~20 targets while CLAUDE.md designates it authoritative for the full
list. Rewritten with all targets, grouped, and the suffix rule stated.
- README.md told readers to "git clone" into user/, which is a submodule.
- architecture.md: nav is Home + Trips + (authenticated) New Post, not
"Home + Past Trips only"; template tree omitted trips.html.twig,
post-form.html.twig and forms/, and placed base.html.twig at templates/ root
rather than in partials/; entry-actions has three API routes, not just delete;
added the undocumented css-compiled/maplibre-gl.css output and a section on
the /post pin editor as the one sanctioned non-entry-map map.
- design-system.md: documented 13 colour tokens against 19 in tokens.css
(missing --color-error, --color-draft-accent and four glass overlays); claimed
"all 3 map templates"; and described --color-canvas as "white".
- design-system-light.md documented a light palette in present tense. No light
mode exists — tokens.css has a single :root block, no prefers-color-scheme or
data-theme switch, and no light hex appears in css/. Banner added.
- posting.md said photos were optional; they are required, 1-6. It documented
hero_image, which was removed for entries (stories keep it). It had no mention
of the frontend edit flow or photo editor, both shipped 2026-07-08. Photo
files are photo-01..NN, zero-padded.
- working/README.md advertised summary.md as the project's "current state" while
summary.md describes Leaflet, /tracker, /map and /stats. Most misleading line
in the tree.
- CLAUDE.md: recorded js/src/location-map.js as the one sanctioned exception to
the single-map-path rule, and documented that make start/setup fail on a clean
checkout because docker-compose.yml still builds a travel-memories service
whose source moved out in a80b0a9.
Also: 2026-07-23-post-form-location-override.md read "Not started" while merged
in user/ as dd19995; status corrected.
Findings that are not documentation problems — the compose breakage, a
repeatable drift check, the unused shortcode-gallery-plusplus, and demo fixtures
for retired views — are collected in
docs/working/2026-07-25-doc-drift-recommendations.md and deliberately not acted
on. Design and verification method: docs/working/specs/2026-07-25-docs-reconciliation-design.md
The submodule gitlink is deliberately not bumped.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -2,6 +2,18 @@
|
||||
|
||||
**Goal:** Every entry is richer out of the box — location name shown, weather auto-captured, photos in a proper gallery, hero image visible on the feed.
|
||||
|
||||
> **Historical — written 2026-06-21. Mostly shipped as specified; three details reversed.**
|
||||
>
|
||||
> Still true: the location badge, Open-Meteo weather auto-fetch with its eight `weather_desc` values,
|
||||
> and the entry photo gallery. Reversed since:
|
||||
> - **§1.5 gallery** is PhotoSwipe, not `shortcode-gallery-plusplus` (R10).
|
||||
> - **§1.6 `hero_image`** no longer exists on entries — the hero is the first uploaded photo, and the
|
||||
> owner controls photo order by drag-reorder (R7). Stories still use `hero_image`.
|
||||
> - **Photos are now required** (1–6 per entry), not optional (R8).
|
||||
> - **"Tracker feed"** is the trip page and the home active-trip view; there is no `/tracker` (R3).
|
||||
>
|
||||
> Details: [`../../reference/superseded-decisions.md`](../../reference/superseded-decisions.md).
|
||||
|
||||
---
|
||||
|
||||
## User Stories
|
||||
|
||||
@@ -2,6 +2,21 @@
|
||||
|
||||
**Goal:** A `/map` page shows all entries as markers on an interactive Leaflet.js map, connected by a chronological route line, with popups linking to entries.
|
||||
|
||||
> **Superseded — written 2026-06-21. Neither the `/map` page nor Leaflet exists.**
|
||||
>
|
||||
> - **No `/map` route.** The map renders inline on the trip page via the single shared partial
|
||||
> `templates/partials/entry-map.html.twig` (R1, retired 2026-07-04). `CLAUDE.md` forbids
|
||||
> re-creating it or linking to it.
|
||||
> - **Leaflet + OpenStreetMap tiles → MapLibre GL JS** with a CartoDB dark-matter basemap (R4,
|
||||
> 2026-06-20).
|
||||
> - **§2.6 nav link** is gone with the page (R6).
|
||||
>
|
||||
> The *substance* of this spec survived — markers per entry, chronological route line, popups linking
|
||||
> to entries, bounds fitting, mobile touch handling — it all lives in `MapUtils.initEntryMap()` in
|
||||
> `user/themes/intotheeast/js/maplibre-utils.js`. Only the page and the library changed.
|
||||
>
|
||||
> Details: [`../../reference/superseded-decisions.md`](../../reference/superseded-decisions.md).
|
||||
|
||||
---
|
||||
|
||||
## User Stories
|
||||
|
||||
@@ -2,6 +2,17 @@
|
||||
|
||||
**Goal:** A `/stats` page showing key trip numbers: days on the road, entries posted, countries visited, and approximate distance traveled.
|
||||
|
||||
> **Superseded — written 2026-06-21. There is no `/stats` page.**
|
||||
>
|
||||
> The stats themselves shipped and still work — days on the road, entries posted, countries visited,
|
||||
> distance (exact from GPX, or a `~`-prefixed haversine estimate without it). They render **inline on
|
||||
> the trip page** behind a toggle, computed by `window.initTripStats()` in `js/src/main.js`
|
||||
> (R2, retired 2026-07-04). `CLAUDE.md` forbids re-creating the standalone view.
|
||||
>
|
||||
> Also reversed: **§3.7 nav link** (R6), and the `/tracker` references (R3).
|
||||
>
|
||||
> Details: [`../../reference/superseded-decisions.md`](../../reference/superseded-decisions.md).
|
||||
|
||||
---
|
||||
|
||||
## User Stories
|
||||
|
||||
@@ -2,6 +2,20 @@
|
||||
|
||||
**Goal:** Embed a compact interactive map above the entry feed on the tracker page, showing recent entry positions and the current location, giving readers immediate spatial context.
|
||||
|
||||
> **Superseded — written 2026-06-21. The idea won; this implementation did not.**
|
||||
>
|
||||
> A map beside the feed is exactly what the site does now — but not as a separate "mini-map":
|
||||
> - **No `/tracker` page** to embed it above (R3). The map sits in a column on the trip page and the
|
||||
> home active-trip view.
|
||||
> - **No second map implementation.** This spec's `feed-map` variant with its own inline init was
|
||||
> deleted; everything goes through the one shared `partials/entry-map.html.twig` +
|
||||
> `MapUtils.initEntryMap()` path (R12, consolidated 2026-06-27). Adding a second display map is
|
||||
> forbidden by `CLAUDE.md`.
|
||||
> - **Leaflet → MapLibre GL JS** (R4), so §4.1's `if (typeof L === 'undefined')` guard is obsolete.
|
||||
> - **No "View full map →" link** — there is no full map page to link to (R1).
|
||||
>
|
||||
> Details: [`../../reference/superseded-decisions.md`](../../reference/superseded-decisions.md).
|
||||
|
||||
---
|
||||
|
||||
## User Stories
|
||||
|
||||
Reference in New Issue
Block a user