forked/topola-viewer
1
0
Fork 0
mirror of https://github.com/PeWu/topola-viewer.git synced 2026-07-25 13:11:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Format markdown files

Browse Source
This commit is contained in:
Przemek Więch
2026-07-05 22:51:04 +02:00
parent 72abbc7e7e
commit 85df7d13bb
27 changed files with 3602 additions and 1541 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/README.md
View File

@@ -1,16 +1,32 @@
# Topola Viewer Feature Designs
This directory contains technical design documents for some of the new features and architectural updates of the Topola Viewer.
This directory contains technical design documents for some of the new features
and architectural updates of the Topola Viewer.
These documents are inspired by the design methodology described in the blog post [Elephants, Goldfish and the New Golden Age of Software Engineering](https://drensin.medium.com/elephants-goldfish-and-the-new-golden-age-of-software-engineering-c33641a48874) by Dave Rensin.
These documents are inspired by the design methodology described in the blog
post
[Elephants, Goldfish and the New Golden Age of Software Engineering](https://drensin.medium.com/elephants-goldfish-and-the-new-golden-age-of-software-engineering-c33641a48874)
by Dave Rensin.
While new features *may* follow this methodology to ensure robust design validation and context safety before writing code, doing so is optional.
While new features _may_ follow this methodology to ensure robust design
validation and context safety before writing code, doing so is optional.
## Design Documents Registry
* **[DOCKER_DESIGN.md](DOCKER_DESIGN.md)**: Docker container packaging, lightweight Caddy web server configuration, and GitHub Actions publishing pipelines.
* **[IMMEDIATE_FAMILY_SECTION_DESIGN.md](IMMEDIATE_FAMILY_SECTION_DESIGN.md)**: Side panel block consolidating parents, spouses, and children for efficient off-screen tree navigation.
* **[PLAYWRIGHT_DESIGN.md](PLAYWRIGHT_DESIGN.md)**: Playwright E2E testing architecture, Vite development/preview server lifecycle integration, tracking blocker interceptors, and embedded iframe communication.
* **[SCREENSHOT_TESTS_DESIGN.md](SCREENSHOT_TESTS_DESIGN.md)**: Pixel-perfect visual regression testing infrastructure, animation stabilization, sandbox environment/DOM sanitization, and isolated Playwright projects.
* **[WEBMCP_DESIGN.md](WEBMCP_DESIGN.md)**: Model Context Protocol (MCP) bridge and TS tool registration for AI agent interaction.
* **[PROBERS_DESIGN.md](PROBERS_DESIGN.md)**: Live prober smoke tests against deployed GitHub Pages, WikiTree URLs, and local Docker container, covering WikiTree API, CORS proxy, GEDCOM-from-URL, and Docker build paths.
- **[DOCKER_DESIGN.md](DOCKER_DESIGN.md)**: Docker container packaging,
lightweight Caddy web server configuration, and GitHub Actions publishing
pipelines.
- **[IMMEDIATE_FAMILY_SECTION_DESIGN.md](IMMEDIATE_FAMILY_SECTION_DESIGN.md)**:
Side panel block consolidating parents, spouses, and children for efficient
off-screen tree navigation.
- **[PLAYWRIGHT_DESIGN.md](PLAYWRIGHT_DESIGN.md)**: Playwright E2E testing
architecture, Vite development/preview server lifecycle integration, tracking
blocker interceptors, and embedded iframe communication.
- **[SCREENSHOT_TESTS_DESIGN.md](SCREENSHOT_TESTS_DESIGN.md)**: Pixel-perfect
visual regression testing infrastructure, animation stabilization, sandbox
environment/DOM sanitization, and isolated Playwright projects.
- **[WEBMCP_DESIGN.md](WEBMCP_DESIGN.md)**: Model Context Protocol (MCP) bridge
and TS tool registration for AI agent interaction.
- **[PROBERS_DESIGN.md](PROBERS_DESIGN.md)**: Live prober smoke tests against
deployed GitHub Pages, WikiTree URLs, and local Docker container, covering
WikiTree API, CORS proxy, GEDCOM-from-URL, and Docker build paths.