docs: refresh README platform stack and add architecture GIF export - #31
Merged
cmcornejocrespo merged 3 commits intoSep 9, 2026
Merged
Conversation
Replace the ASCII stack with a Mermaid layer diagram, a tagged component table, and links to the live map and AGENTS.md tech matrix. Co-authored-by: Cursor <cursoragent@cursor.com>
Playwright frame-by-frame capture from v5 Overall Demo plus ffmpeg palettegen; defaults to request-path hops 0–6. Fix PNG/GIF export page load (networkidle timeout on live companion polling). Co-authored-by: Cursor <cursoragent@cursor.com>
Three side-by-side GIFs (request-path, request-response, full) plus local README and regen script. Intentionally temporary — remove assets/preview/ and export-architecture-gif-preview.sh once a winner is chosen (see assets/preview/README.md). Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
make export-architecture-gif) — Playwright frame capture per hop + ffmpeg palettegen; default covers request-path hops 0–6.assets/preview/(three variants + local README) so we can pick a winner before wiring the final asset into README.page.gotowait (loadinstead ofnetworkidle) — live companion polling caused Playwright timeouts.Details
The static README diagram (
assets/overall-architecture.png) already comes from v5 Overall Demo viamake export-architecture. This PR adds an animated counterpart and improves the prose stack section for first-time readers.tests/export-architecture-gif.mjsscripts/export-readme-architecture-gif.shmake export-architecture-gifassets/preview/README.mdcomparing scope/durationscripts/export-architecture-gif-preview.shTemporary preview cleanup (after we pick a variant): delete
assets/preview/andscripts/export-architecture-gif-preview.sh, copy the winner toassets/overall-architecture.gif, adjust defaults inexport-architecture-gif.mjsif needed, optionally embed in README. Seeassets/preview/README.md.Key findings during testing:
networkidleonv5/live.htmltimes out locally (observability/proxy polling);load+ existing FlowStory waits is sufficient.Test plan
make export-architecture-gif— writesassets/overall-architecture.gif./scripts/export-architecture-gif-preview.sh— writes three variants underassets/preview/assets/preview/and choose variant for READMEassets/preview/README.mdMade with Cursor