Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/ACCESSIBILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tree has **not** completed a formal WCAG audit.

## Status (June 2026)

| Area | Status |
| ------------------------------------ | ------------------------------------------------------------------------------------------------ |
| Formal WCAG 2.x conformance audit | **Not completed** |
| Keyboard use in map/list UI | Partial — varies by component |
| Screen reader support for map canvas | **Limited** — OpenLayers canvas model |
| Focus management in modals/overlays | Partial (e.g. focus-trap in some UI) |
| Colour contrast | **Host-dependent** — theming via CSS |
| Automated a11y tests in CI | Planned (Playwright a11y checks — see [Current vs target](../architecture/CURRENT_VS_TARGET.md)) |
| Area | Status |
| ------------------------------------ | ------------------------------------- |
| Formal WCAG 2.x conformance audit | **Not completed** |
| Keyboard use in map/list UI | Partial — varies by component |
| Screen reader support for map canvas | **Limited** — OpenLayers canvas model |
| Focus management in modals/overlays | Partial (e.g. focus-trap in some UI) |
| Colour contrast | **Host-dependent** — theming via CSS |
| Automated a11y tests in CI | Planned (Playwright a11y checks) |

---

Expand Down
19 changes: 9 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Mapsight documentation

Mapsight is **actively evolving (WIP)**: used in controlled production deployments, not yet a turnkey product for
self-service integrators. See [Current vs target](architecture/CURRENT_VS_TARGET.md) and [Licensing](LICENSING.md).
self-service integrators. See [Licensing](LICENSING.md).

---

Expand Down Expand Up @@ -37,20 +37,19 @@ Maintainer deployments currently exercise:
- Basemap tile proxy pattern — [`TILE_PROXY`](integration/TILE_PROXY.md)
- Declarative embed config + Redux runtime — [Redux architecture](../packages/core/docs/REDUX_ARCHITECTURE.md)

**Still evolving:** full Infosite Java guide, SSR sidecar standardization, i18n library choice — see
[Current vs target](architecture/CURRENT_VS_TARGET.md).
**Still evolving:** full Infosite Java guide, SSR sidecar standardization, i18n library choice — track in
[GitHub issues](https://github.com/open-mapsight/mapsight/issues).

---

## Architecture

| Document | About |
| --------------------------------------------------------- | ------------------------------------------- |
| [ECOSYSTEM.md](architecture/ECOSYSTEM.md) | Technical deployment stack, repos, basemaps |
| [PRINCIPLES.md](architecture/PRINCIPLES.md) | Product goals and non-goals |
| [CURRENT_VS_TARGET.md](architecture/CURRENT_VS_TARGET.md) | Implementation status matrix |
| [Decisions](architecture/decisions/README.md) | Architecture decision notes |
| [Project history](project/HISTORY.md) | Origin timeline (unverified) |
| Document | About |
| --------------------------------------------- | ------------------------------------------- |
| [ECOSYSTEM.md](architecture/ECOSYSTEM.md) | Technical deployment stack, repos, basemaps |
| [PRINCIPLES.md](architecture/PRINCIPLES.md) | Product goals and non-goals |
| [Decisions](architecture/decisions/README.md) | Architecture decision notes |
| [Project history](project/HISTORY.md) | Origin timeline (unverified) |

## Ecosystem

Expand Down
81 changes: 0 additions & 81 deletions docs/architecture/CURRENT_VS_TARGET.md

This file was deleted.

89 changes: 44 additions & 45 deletions docs/architecture/ECOSYSTEM.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,50 +14,50 @@ Typical **municipal or regional** deployment (many components are optional):

```mermaid
flowchart TB
subgraph ingress [Ingress]
Proxy["Caddy / Apache reverse proxy"]
end
subgraph content [Content and delivery]
CMS["CMS e.g. Infosite TYPO3"]
end
subgraph frontend [Mapsight frontend - this monorepo]
Apps["SPAs and embed builds"]
Packages["@mapsight/core + @mapsight/ui"]
end
subgraph backend [Companion services - mapsight-pulp monorepo]
Pulp["mapsight-pulp PHP ETL"]
Platform["Host data platform optional"]
end
subgraph optional [Optional pro frontend]
GP["Geoportal e.g. Masterportal CIVITAS"]
end
subgraph data [Data infrastructure]
GS["GeoServer WMS WFS"]
Ext["External HTTP feeds"]
end
subgraph basemap [Basemap tiles]
TileProxy["tile-proxy optional"]
Upstream["OSM basemap.de geo dept XYZ"]
end
Proxy --> CMS
Proxy --> Apps
Proxy --> Pulp
Proxy --> Platform
Proxy --> GP
Proxy --> TileProxy
CMS -->|"pages embeds declarative JSON"| Apps
CMS -->|"GeoJSON content APIs"| Pulp
CMS -->|"GeoJSON content APIs"| Apps
Apps --> Packages
Apps -->|"fetch GeoJSON"| Pulp
Apps -->|"HTTP API"| Platform
Apps -->|"basemap XYZ"| TileProxy
Apps -->|"WMS raster basemap"| GS
TileProxy --> Upstream
TileProxy --> GS
GP --> GS
Pulp --> Ext
Platform --> Ext
subgraph ingress [Ingress]
Proxy["Caddy / Apache reverse proxy"]
end
subgraph content [Content and delivery]
CMS["CMS e.g. Infosite TYPO3"]
end
subgraph frontend [Mapsight frontend - this monorepo]
Apps["SPAs and embed builds"]
Packages["@mapsight/core + @mapsight/ui"]
end
subgraph backend [Companion services - mapsight-pulp monorepo]
Pulp["mapsight-pulp PHP ETL"]
Platform["Host data platform optional"]
end
subgraph optional [Optional pro frontend]
GP["Geoportal e.g. Masterportal CIVITAS"]
end
subgraph data [Data infrastructure]
GS["GeoServer WMS WFS"]
Ext["External HTTP feeds"]
end
subgraph basemap [Basemap tiles]
TileProxy["tile-proxy optional"]
Upstream["OSM basemap.de geo dept XYZ"]
end
Proxy --> CMS
Proxy --> Apps
Proxy --> Pulp
Proxy --> Platform
Proxy --> GP
Proxy --> TileProxy
CMS -->|" pages embeds declarative JSON "| Apps
CMS -->|" GeoJSON content APIs "| Pulp
CMS -->|" GeoJSON content APIs "| Apps
Apps --> Packages
Apps -->|" fetch GeoJSON "| Pulp
Apps -->|" HTTP API "| Platform
Apps -->|" basemap XYZ "| TileProxy
Apps -->|" WMS raster basemap "| GS
TileProxy --> Upstream
TileProxy --> GS
GP --> GS
Pulp --> Ext
Platform --> Ext
```

The **CMS** is both a **delivery channel** and often a **content source**: it hosts Mapsight embeds (HTML snippets or
Expand Down Expand Up @@ -128,7 +128,6 @@ back-office tools.
## Related docs

- [Principles](PRINCIPLES.md) — scope, composable UI, non-goals
- [Current vs target](CURRENT_VS_TARGET.md) — implementation status
- [@mapsight/core → Redux architecture](../../packages/core/docs/REDUX_ARCHITECTURE.md) — declarative GIS runtime
- [mapsight-pulp](https://github.com/open-mapsight/mapsight-pulp) — PHP companion monorepo
- [tile-proxy](https://github.com/open-mapsight/mapsight-pulp) — basemap
Expand Down
3 changes: 1 addition & 2 deletions docs/architecture/PRINCIPLES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Architecture principles

North-star goals for Mapsight as a **communicative, embed-first** GIS frontend. For deployment topology
see [Ecosystem](ECOSYSTEM.md); for implementation status see [Current vs target](CURRENT_VS_TARGET.md).
see [Ecosystem](ECOSYSTEM.md).

---

Expand Down Expand Up @@ -94,6 +94,5 @@ map product shape that fits the content — not a shared GIS portal skin.
## Related

- [Ecosystem](ECOSYSTEM.md)
- [Current vs target](CURRENT_VS_TARGET.md)
- [Decisions](decisions/README.md)
- [Licensing](../LICENSING.md)
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,3 @@ cache.
- [`packages/ui/src/js/store/actions.ts`](../../../packages/ui/src/js/store/actions.ts) — legacy hand-rolled fetch
actions (to replace)
- [Decision 005](005-fetch-and-tanstack-query-over-axios.md)
- [Current vs target](../CURRENT_VS_TARGET.md#runtime-and-state)
3 changes: 1 addition & 2 deletions docs/architecture/decisions/007-ui-styling-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Option **C** explicitly allows a municipal site on SCSS overrides while a domain
migration ([Decision 009](009-native-css-over-scss.md)) would shift Option A toward custom properties without changing
the composable goal.

Do **not** document “Mapsight uses shadcn globally” until a migration is real. Track progress
in [Current vs target](../CURRENT_VS_TARGET.md).
Do **not** document “Mapsight uses shadcn globally” until a migration is real.

## Consequences

Expand Down
1 change: 0 additions & 1 deletion docs/architecture/decisions/008-i18n-approach.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,4 @@ Until this note is updated with a library choice:
## References

- [Principles → UX goals](../PRINCIPLES.md#ux-goals)
- [Current vs target](../CURRENT_VS_TARGET.md#runtime-and-state)
- Planned: [POSITIONING.md](../../ecosystem/POSITIONING.md) — Masterportal i18next as reference
1 change: 0 additions & 1 deletion docs/architecture/decisions/009-native-css-over-scss.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,3 @@ vector-style-compiler internals.
styleFunction out
- [`packages/vector-style-compiler/src/js/cli.ts`](../../../packages/vector-style-compiler/src/js/cli.ts) — optional
Sass pre-step only
- [Current vs target](../CURRENT_VS_TARGET.md)
1 change: 0 additions & 1 deletion docs/architecture/decisions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ is useful to preserve.
## Related

- [Principles](../PRINCIPLES.md)
- [Current vs target](../CURRENT_VS_TARGET.md)
Loading