[luv-320] docs: swap README hero gif to readme-arch-hq#321
Merged
NiveditJain merged 9 commits intomainfrom May 9, 2026
Merged
Conversation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe README header is reworked and the centered hero GIF is replaced from ChangesREADME & i18n asset swap
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
# Conflicts: # CHANGELOG.md
Mirror the English README's swap from `failproofai-hq.gif` to `readme-arch-hq.gif` so every locale renders the new architecture GIF instead of the missing legacy filename. Alt text in each language is preserved unchanged. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…q.gif Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
19-19: 🏗️ Heavy liftConsider further optimizing the GIF file size.
While the new asset is ~45% smaller than the original (10.4 MB vs 19 MB), a 10.4 MB GIF will still impact README load times, especially for users on slower connections or mobile devices.
Consider:
- Further GIF optimization (frame reduction, color palette optimization)
- Converting to WebM/MP4 format (typically 80-90% smaller than GIF)
- Hosting the asset on a CDN (similar to the logo at line 3) with lazy loading
- Creating a poster image placeholder
The logo already uses CloudFront CDN hosting; the same approach could work for the hero asset.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 19, Replace the large GIF referenced by the img tag src="readme-arch-hq.gif" in README.md with a lighter-weight delivery: either further optimize the GIF (frame reduction, palette reduction) or convert to a WebM/MP4 video and replace the img usage with a video or picture element; host the resulting asset on the same CDN used for the logo and update the src to the CDN URL; add lazy loading (loading="lazy" for images or preload="none"/autoplay muted loop playsinline for videos) and include a small poster/placeholder image to avoid heavy initial load and improve perceived performance.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 19: Replace the large GIF referenced by the img tag
src="readme-arch-hq.gif" in README.md with a lighter-weight delivery: either
further optimize the GIF (frame reduction, palette reduction) or convert to a
WebM/MP4 video and replace the img usage with a video or picture element; host
the resulting asset on the same CDN used for the logo and update the src to the
CDN URL; add lazy loading (loading="lazy" for images or preload="none"/autoplay
muted loop playsinline for videos) and include a small poster/placeholder image
to avoid heavy initial load and improve perceived performance.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5be078d8-7946-4e75-9813-31b2445de39b
⛔ Files ignored due to path filters (1)
failproofai-hq.gifis excluded by!**/*.gif
📒 Files selected for processing (16)
CHANGELOG.mdREADME.mddocs/i18n/README.ar.mddocs/i18n/README.de.mddocs/i18n/README.es.mddocs/i18n/README.fr.mddocs/i18n/README.he.mddocs/i18n/README.hi.mddocs/i18n/README.it.mddocs/i18n/README.ja.mddocs/i18n/README.ko.mddocs/i18n/README.pt-br.mddocs/i18n/README.ru.mddocs/i18n/README.tr.mddocs/i18n/README.vi.mddocs/i18n/README.zh.md
✅ Files skipped from review due to trivial changes (14)
- docs/i18n/README.he.md
- docs/i18n/README.tr.md
- docs/i18n/README.de.md
- docs/i18n/README.zh.md
- docs/i18n/README.fr.md
- docs/i18n/README.ko.md
- docs/i18n/README.vi.md
- docs/i18n/README.es.md
- docs/i18n/README.ru.md
- docs/i18n/README.hi.md
- docs/i18n/README.ar.md
- docs/i18n/README.pt-br.md
- docs/i18n/README.it.md
- docs/i18n/README.ja.md
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.md
…cense, tighter policy table Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
3-3: Consider hosting the logo in the repository for better reliability.The logo is currently hosted on a CloudFront CDN and is accessible. However, using a CDN for critical documentation assets like the main README logo introduces a dependency on external infrastructure. For better resilience, consider storing
logo-wordmark.pngdirectly in the repository (e.g.,assets/logo-wordmark.png) and referencing it locally instead.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 3, Replace the external CloudFront image reference in README (the <img src="https://d2wq11aau0arks.cloudfront.net/failproof/logo-wordmark.png" ...> tag) by adding the file logo-wordmark.png into the repository (suggested path assets/logo-wordmark.png) and update the README img src to point to that local path; commit the new image file and the updated README so the logo loads from the repository rather than the CDN.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 3: Replace the external CloudFront image reference in README (the <img
src="https://d2wq11aau0arks.cloudfront.net/failproof/logo-wordmark.png" ...>
tag) by adding the file logo-wordmark.png into the repository (suggested path
assets/logo-wordmark.png) and update the README img src to point to that local
path; commit the new image file and the updated README so the logo loads from
the repository rather than the CDN.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 10f272dd-5074-4bc1-975c-b41cb926b291
📒 Files selected for processing (2)
CHANGELOG.mdREADME.md
✅ Files skipped from review due to trivial changes (1)
- CHANGELOG.md
This was referenced May 9, 2026
NiveditJain
added a commit
that referenced
this pull request
May 9, 2026
…s when an auto-PR is open (#325) Previously the consolidate step exited early if any "[auto] update translations" PR was open and the cache-save step ran first, so translations queued during a busy push window were marked done in cache but never landed in any branch. Empirically verified against the README rewrite in #321: the per-language `Translate` jobs successfully translated all 14 i18n READMEs (visible in run 25588145237 logs as `translated (3258+3048 tokens)` lines), but the consolidate job logged `Translation PR already open. Skipping.` and PR #324 only contained 14 dashboard.mdx files — the 14 README translations were stuck on the pre-redesign 358-line layout while the English README dropped to 171 lines. Fix: when an auto-PR is open, snapshot the freshly-generated docs/ tree + merged cache via tar before any branch ops, fetch and force-checkout the existing PR's branch, then untar on top so the newest English source always wins. PR creation only fires when no existing PR matched. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
This was referenced May 9, 2026
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.
Summary
README.mdwith a new layout: CDN-hosted wordmark logo, shields.io badges (npm / CI / Slack / Docs / License — weekly-downloads badge dropped per review), the translation strip pulled back up to the header (mirrors the old layout), the existing 7-CLI logo grid kept verbatim with its install hint + beta caveat, a tighterWhat it stopstable leaning on the git policies (block-push-master/block-force-push/block-work-on-main/block-rm-rf/sanitize-api-keys), a newLicensesection calling out the MIT + Commons Clause split, and a documentation index linking todocs.befailproof.ai.readme-arch-hq.gif(10.4 MB, checked into the repo root). The oldfailproofai-hq.gif(19 MB) is removed.docs/i18n/README.*.mdfiles have their<img src="…">swapped to the new filename in this branch as well; the structural rewrite is left to the nexttranslate-docsworkflow run onmain.CHANGELOG.md## Unreleased→### Docsentry covers everything above and references [luv-320] docs: swap README hero gif to readme-arch-hq #321.Test plan
grep -rn 'failproofai-hq.gif' .→ onlyCHANGELOG.md(historical mention) references the old filename; no live image references remain.package.jsonversion is0.0.10-beta.8; the changelog entry sits under## Unreleased, matching project convention (Unreleased accumulates entries until a release is cut).<picture>), alldocs.befailproof.ai/...links resolve.translate-docsrun onmain, confirm the i18n READMEs have been regenerated against the new English structure.🤖 Generated with Claude Code
Summary by CodeRabbit