Skip to content

docs: improve README product framing and visuals#44

Open
DaCameraGirl wants to merge 2 commits into
mainfrom
docs/readme-product-visuals
Open

docs: improve README product framing and visuals#44
DaCameraGirl wants to merge 2 commits into
mainfrom
docs/readme-product-visuals

Conversation

@DaCameraGirl

Copy link
Copy Markdown
Owner

Summary

Improves the Bettin2Win README so the project is easier to understand as a product and portfolio piece.

Changes

  • Added animated SVG hero/demo image
  • Added clearer product framing for what users see
  • Added visible informational-use disclaimer near the top
  • Added stack/language visual
  • Added provider-flow visual
  • Added current status checklist
  • Added repo-local README assets under docs/assets
  • Updated .gitattributes so SVG assets do not skew language stats

Verification

  • README renders locally
  • SVG assets are repo-local
  • GitHub language stats protected through .gitattributes

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 56b8121f48

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
```bash
cd services/racing-analytics
python -m venv .venv
. .venv/Scripts/activate

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use a POSIX venv activation path in bash instructions

This block is marked as bash, but after python -m venv .venv on macOS/Linux the activation script is .venv/bin/activate; .venv/Scripts/activate is the Windows layout. As written, Unix users copying the root README hit No such file or directory before installing deps or running FastAPI, so include both platform paths or switch this command to . .venv/bin/activate.

Useful? React with 👍 / 👎.

.beat { animation: beat 1.8s ease-in-out infinite; transform-origin: center; transform-box: fill-box; }
@keyframes beat { 0%, 100% { transform: scale(1); opacity: 0.75; } 50% { transform: scale(1.08); opacity: 1; } }
@media (prefers-reduced-motion: reduce) {
.beat, animateMotion { animation: none !important; }

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Honor reduced-motion for SMIL animations

For users with prefers-reduced-motion: reduce, this rule still leaves the provider dots moving because animation: none only disables CSS animations, while the seven <animateMotion repeatCount="indefinite"> elements below are SMIL animations. Since this SVG is embedded in the README as an animated preview, provide a static fallback or remove/disable the animateMotion elements under the reduced-motion path so the preference is actually respected.

Useful? React with 👍 / 👎.

<rect class="panel" x="0" y="0" width="500" height="280" rx="24"/>
<rect x="22" y="20" width="456" height="42" rx="18" fill="rgba(255,255,255,0.06)"/>
<text class="tiny" x="42" y="47">provider pulse</text>
<g class="ticker" transform="translate(175 28)">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve the ticker translate while animating it

Because .ticker animates the CSS transform property on this same <g>, browsers treat that property as overriding the SVG transform="translate(175 28)" attribute while the animation runs. In the README preview this makes the odds ticker start at the panel origin and slide over the provider pulse label instead of staying in the header lane; move the static offset to a parent group or include it in the keyframes.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant