docs(051): README hero — frosted-tiles banner + demo GIF#488
Merged
Conversation
Deploying mcpproxy-docs with
|
| Latest commit: |
6fac614
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3694e19f.mcpproxy-docs.pages.dev |
| Branch Preview URL: | https://feat-051-readme-hero-demo.mcpproxy-docs.pages.dev |
📦 Build ArtifactsWorkflow Run: View Run Available Artifacts
How to DownloadOption 1: GitHub Web UI (easiest)
Option 2: GitHub CLI gh run download 26241282640 --repo smart-mcp-proxy/mcpproxy-go
|
…tivity - Boot throwaway core with neutral demo servers (filesystem/fetch/time/everything; memory quarantined) instead of the real 25-server app for the web beats. - Generate real activity by calling tools through the proxy so the activity log is populated (successes + a sensitive-data flag), not near-empty. - Spinner/auth-modal/onboarding guards in the capture so no loading states are filmed. - build-demo.sh: 5-segment stitch (tray still + servers/tools/activity/memory), portable array (no mapfile; macOS bash 3.2).
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…drawer; drop tools search - Tray beat: replace constant Ken-Burns zoom with a 3-phase animation — roll the menu down, highlight the 'Open Web UI' item (macOS-style blue selection), then a 1s shake. Built from the still in ffmpeg (segA roll / segB highlight-swap / segC shake). - Activity beat: open the detail drawer on the newest Tool Call (the sensitive-data echo) to show full event details incl. the detection. - Tools beat: drop the search-typing scene; show the tool list + approval states.
… cross-platform messaging - demo.gif: drop the tray beat — now 4 web-UI beats (servers/tools/activity/security). - social.png banner: use the real logo.svg (MCP shield) instead of the emoji. - README: add static macOS screenshots (menu-bar app + activity log) and clarify the core is a single cross-platform binary (macOS/Linux/Windows) with the web UI embedded; macOS additionally ships an optional menu-bar app. - build-demo.sh: web-only 4-segment stitch; scripts/demo/README updated.
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
2 participants
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.
Implements
specs/051-readme-hero-demo(brainstormed design + plan committed in-branch).What
A CodexBar-style README hero, plus a scripted pipeline to regenerate the assets.
docs/social.html→docs/social.png— frosted-tiles hero banner ("Supercharge AI Agents, Safely", blue→green on navy, 4 capability pills). Rendered via headless Chromium. Doubles as the GitHub social-preview image.docs/demo.gif— one cohesive ~21s demo (860×538, 7.3MB): tray menu → server dashboard (federation) → tools (discovery) → activity log (audit, with a sensitive-data flag) → quarantined-server detail (security). Tray via themcpproxy-ui-testMCP; web UI via Playwrightvideo; stitched with ffmpeg.scripts/demo/—render-banner.sh,capture-tray.md,capture-webui.spec.ts+playwright.config.ts,build-demo.sh, run-orderREADME.md. Assets regenerate, not hand-made once.Demo provenance (clean re-record)
11/25 serverswhile the web beats show 5 — a known cosmetic mismatch; a fully-clean tray would need a brief live-config swap.Notes for review
demo.webpnot shipped — ffmpeg 8.0's libwebp animated encoder hits an internal threading bug even single-threaded;build-demo.shtreats webp as non-fatal. The GIF is the README embed.build-demo.shrealities: tray beat is a single Ken-Burns still (UI-test MCP can't screenshot expanded submenus); concat uses the filter with per-inputsetsar=1(the demuxer-c copysilently dropped mismatched segments); portable array fill (macOS bash 3.2 has nomapfile).localStorageand points at the demo core viaMCPPROXY_BASE_URL(the default is:8080).Manual follow-up (cannot be scripted)
docs/social.pngto Settings → Social preview to control HN/Slack/X unfurls.