refactor: clean up MEV Blocker documentation #585
Conversation
|
Deployment failed with the following error: View Documentation: https://vercel.com/docs/accounts/team-members-and-roles |
📝 WalkthroughWalkthroughThis PR removes most in-repo MEV Blocker documentation, replaces the main README with a MevBlockerInterstitial React component (10s redirect), adds sidebar filtering and a NotFound override for /mevblocker/* paths, and adds a hosting redirect rule to funnel traffic to the interstitial/external docs. Changes
Sequence Diagram(s)sequenceDiagram
participant Browser
participant Vercel
participant DocsSite as "Docusaurus Site"
participant Interstitial as "MevBlockerInterstitial"
participant External as "https://docs.mevblocker.io/"
Browser->>Vercel: GET /mevblocker/some/path
Vercel-->>Browser: 301 Redirect -> /mevblocker
Browser->>DocsSite: GET /mevblocker
DocsSite->>Interstitial: Render interstitial page
Interstitial-->>Browser: Serve page + meta-refresh (10s) and JS countdown
Note right of Interstitial: useEffect timers update countdown and trigger redirect
Interstitial->>Browser: window.location.replace(External) after delay
Browser->>External: GET https://docs.mevblocker.io/
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@src/components/MevBlockerInterstitial.module.css`:
- Around line 1-10: The component references styles.page but the CSS module only
defines .card, so add a .page rule to MevBlockerInterstitial.module.css (or
remove the usage in the component); implement a `.page` selector (e.g., .page {
width: 100%; min-height: 100vh; display: flex; justify-content: center;
align-items: center; padding: 24px; background: transparent; } ) to provide the
wrapper layout used alongside .card (reference styles.page and .card in the
component) so the interstitial wrapper receives proper sizing and centering.
🧹 Nitpick comments (1)
src/components/MevBlockerInterstitial.tsx (1)
12-25: Simplify the redirect timers to avoid duplicate navigation.Both the interval and timeout call
window.location.replace, and there’s also a meta refresh. Keeping just one JS redirect path reduces duplicate navigation/analytics events while preserving the countdown.♻️ Proposed simplification
useEffect(() => { const intervalId = window.setInterval(() => { - setRemaining((prev) => { - if (prev <= 1) { - window.location.replace(REDIRECT_URL) - return 0 - } - return prev - 1 - }) + setRemaining((prev) => Math.max(prev - 1, 0)) }, 1000) const timeoutId = window.setTimeout(() => { window.location.replace(REDIRECT_URL) }, DELAY_SECONDS * 1000)
alfetopito
left a comment
alfetopito
left a comment
There was a problem hiding this comment.
Should we still have MEV blocker at the docs landing page?
I would argue it shouldn't be there anymore; just keep the redirects for previous paths.
I would consider removing the one on the left panel as well:
Or is bd/marketing expecting to be mentioned there still?
… statement for clarity
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/README.md`:
- Line 10: The README currently states "CoW DAO's three main products" but only
names two products (CoW Protocol and CoW AMM); update the text in README.md to
either add the missing third product name and its short link (if a third product
exists) or change the phrase to "two main products" so the count matches the
listed items; locate and edit the sentence containing "CoW DAO's three main
products" and update the list accordingly (the string "CoW Protocol" and "CoW
AMM" appear in the same sentence).
…include link checks
…roducts offered by CoW DAO
|
@alfetopito addressed your points |
|
Hey @fairlighteth , I did not find the collapsed menu bar, but it looks like you removed it based on @alfetopito feedback. I have 1 question: when I search for 'MEV' using the search bar, I'm navigated to the mevblocker underlying pages with 404 error there, and there is no navigation. Is this something that we need to improve or it is OK to leave it as it is? 
|
|
@elena-zh thanks for reviewing. I think this is expected because the redirects in this PR aren't deployed yet. Also that search uses Algolia and it uses caching. So my suggestion is to review that post merge. |
Description
Added an MEV Blocker interstitial with a 10‑second redirect to https://docs.mevblocker.io/, kept the sidebar showing only a single MEV Blocker entry pointing to that interstitial, and removed all legacy MEV Blocker subpages. Ensured all /mevblocker/* routes permanently redirect to /mevblocker in production and added a dev‑time 404 redirect to mirror that behavior locally.
Changes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.