Add OpenGraph-ready showcase previews and update README showcase section#67
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces several SVG assets to provide visual previews of the project's architecture, dashboard, and social presence. The README.md has been updated to display these assets in a new 'Showcase Preview' section. Review feedback suggests renaming a redundant 'Showcase' heading to 'Demo Resources' to better reflect its content and improve document structure.
| > Add the current Vercel showcase screenshot here when the UI settles: | ||
| > | ||
| > `docs/assets/showcase-home.png` | ||
| ## Showcase |
There was a problem hiding this comment.
The heading ## Showcase is redundant given the ## Showcase Preview section just above it. To improve clarity and better describe this section's content (a list of links), consider renaming it.
Suggested alternatives:
## Demo Resources## Quick Links
| ## Showcase | |
| ## Demo Resources |
There was a problem hiding this comment.
Code Review
This pull request enhances the project's documentation by adding a 'Showcase Preview' section to the README and introducing three new SVG assets: an architecture diagram, an operations dashboard preview, and a social preview image. The reviewer feedback suggests renaming the existing 'Showcase' header to 'Showcase Resources' to better distinguish it from the new visual section. Additionally, an improvement was identified regarding inconsistent horizontal spacing between status badges in the dashboard SVG asset to maintain a high-quality visual presentation.
| > Add the current Vercel showcase screenshot here when the UI settles: | ||
| > | ||
| > `docs/assets/showcase-home.png` | ||
| ## Showcase |
There was a problem hiding this comment.
The PR introduces a new ## Showcase Preview section but also adds a ## Showcase header for the links table. This results in two sections with nearly identical names, which can be confusing. Consider renaming this second header to something more descriptive like ## Showcase Resources or ## Reviewer Links to better distinguish it from the visual preview section.
| ## Showcase | |
| ## Showcase Resources |
| <rect x="92" y="145" width="84" height="29" rx="15" fill="#071a18" stroke="#42e69b"/><text x="108" y="164" class="ok">CI PASS</text> | ||
| <rect x="256" y="145" width="143" height="29" rx="15" fill="#071a22" stroke="#68eaff"/><text x="272" y="164" class="cyan">CONTRACTS OK</text> | ||
| <rect x="420" y="145" width="162" height="29" rx="15" fill="#201611" stroke="#ffc46a"/><text x="435" y="164" class="warn">LOCAL DEGRADED</text> |
There was a problem hiding this comment.
The horizontal spacing between the status badges in the dashboard header is inconsistent. The gap between the first and second badge is 80px, while the gap between the second and third is only 21px. For a 'premium' showcase asset, consistent spacing (e.g., 24px) would improve the visual quality.
<rect x="92" y="145" width="84" height="29" rx="15" fill="#071a18" stroke="#42e69b"/><text x="108" y="164" class="ok">CI PASS</text>
<rect x="200" y="145" width="143" height="29" rx="15" fill="#071a22" stroke="#68eaff"/><text x="216" y="164" class="cyan">CONTRACTS OK</text>
<rect x="367" y="145" width="162" height="29" rx="15" fill="#201611" stroke="#ffc46a"/><text x="382" y="164" class="warn">LOCAL DEGRADED</text>
1 participant
Motivation
Description
Showcase Preview, add explanatory text, embed a social preview image, and add a dashboard/architecture gallery.docs/DEMO_WALKTHROUGH.md,docs/SHOWCASE_READINESS.md,docs/BENCHMARK_EXPLANATION.md, anddocs/API_SURFACE.md.showcase/assets:social-preview.svg,dashboard-preview.svg, andarchitecture-preview.svgused by the README previews.Testing
Codex Task