|
Some checks are pending
build-gate / build (push) Waiting to run
Driver 2026-09-21: 'a folder called deployment which will store the capacitor
folder, wordpress folder and tauri folder', and 'a folder called documentation
to store the contributing folder so docs are in one place'.
docs/ + contributing/ + CONTRIBUTING.md -> documentation/ (three doc homes into
one). capacitor/ + wordpress/ + src-tauri/ -> deployment/.
The public/ -> dist/ rename the Driver asked about is NOT here: after seeing the
measured blast radius (855 tracked files, 54 source refs, and public/ is the
served web-root four consumers point at) the Driver withdrew it - 'keep the
public folder the same'.
Path references were rewritten mechanically (258 across 87 files), but three
classes needed hand fixes because a prefix regex cannot see them:
- join(ROOT,'docs',...) in 10 internal scripts - a quoted SEGMENT, not a prefix
- tauri frontendDist '../public' -> '../../public', since src-tauri is now one
level deeper; check:tauri caught this exactly as the card predicted
- the WordPress contract test's dirname(__DIR__,2) -> 3, same reason
Also reverted one over-reach: the rewrite renamed a FINDING-CATEGORY label
'docs' in public-hygiene-check.mjs, which is a rule name in its own header, not
a path.
Verified: full build ALL GUARDS PASS, SRI consistent; check:tauri, check:mobile
(cap sync + webDir OK), check:wp-embed, quoted-scripts, capability-citations,
capability-exemplars, library-index, public-hygiene, parse and drop all pass.
|
||
|---|---|---|
| .. | ||
| app-wrappers.md | ||
| color-strategies.md | ||
| components.md | ||
| data-sources.md | ||
| embeddability.md | ||
| file-map.md | ||
| i18n.md | ||
| patterns-and-provenance.md | ||
| poster-generation.md | ||
| README.md | ||
documentation/architecture/ — the deep end
Everything complex lives here, on purpose. The rest of the docs stay simple ("what it does"); when a simple doc says "full contract in architecture/…", this is where it points.
| Doc | What it holds |
|---|---|
| file-map.md | every file, one line each, with the gotcha each carries |
| data-sources.md | the api/ seam — connection contract + add-a-source checklist |
| color-strategies.md | the color-strategy contract + legend wiring |
| components.md | shared component catalog + shadow-DOM conventions |
| i18n.md | the locale contract + add-a-language checklist |
| embeddability.md | the generated per-map pages + manifest that make every map embeddable by default |
| app-wrappers.md | the SPA shell: nav.js + PROFILES contracts, bun run shell pipeline |
| poster-generation.md | the poster/preview generator pipeline |
| patterns-and-provenance.md | the two multi-map patterns in depth + where the design comes from |
Simple docs: ../why.md · ../tutorial.md · ../how-to.md · ../reference.md · ../explanation.md