fix: mev blocker docs - #520
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation for MEV Blocker endpoints has been updated to standardize formatting, specifically replacing italicized asterisks with underscores, correcting an image path, adjusting code block formatting, and fixing an escaped asterisk. No functional or content changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (4)
docs/mevblocker/orderflow-originators/Endpoints.md (4)
11-11: Replace non-breaking space after link & tighten wordingA
sneaks in just before the first dash (-). This can trip Markdown parsers and affect wrapping.
While touching the line, consider a lighter sentence that avoids the repeated “The transactions…” boiler-plate.-[**Fast - https://rpc.mevblocker.io/fast**](https://rpc.mevblocker.io/fast) - Used to get transactions included on-chain as fast as possible while also finding users a rebate. _The transactions sent to this endpoint get simulated in pending block._ +[**Fast – https://rpc.mevblocker.io/fast**](https://rpc.mevblocker.io/fast) - Sends the transaction for inclusion as soon as possible while still attempting to secure a rebate. _Transactions to this endpoint are simulated in the pending block._(Same tweak applies to the other three endpoint bullets.)
Also applies to: 17-17, 23-23, 29-29
35-35: Grammar: “DO NOT Get simulated” → clearer wording-_The transactions sent to this endpoint DO NOT Get simulated in pending block._ +_Transactions sent to this endpoint are **not** simulated in the pending block._
45-47: Clean up wording & footnote punctuation-Because of this, we enabled the option for you to choose between sharing the transactions with all permissionlessly connected searchers, for which we know nothing about, or to share the transactions with a curated list of searchers with whom the team might have a bit more background.* +Because of this, you can choose to share transactions with (a) **all** permissionlessly connected searchers or (b) a **curated** list of vetted searchers.* -*Note that the absence of this parameter specific configuration makes all the flow go via the default endpoint +*If neither parameter is supplied, traffic falls back to the default endpoint.*Also note the heading above is misspelled (“Restrictred” ➜ “Restricted”).
52-53: Remove bullet marker inside code blocks for copy-paste friendlinessThe leading “- Endpoint_you_Choose - ” isn’t part of the URL and forces extra cleanup when copying.
- - Endpoint_you_Choose - https://rpc.mevblocker.io/{your_chosen_endpoint}?shareAll=1 +https://rpc.mevblocker.io/{your_chosen_endpoint}?shareAll=1Same for the
shareSafeexample below.Also applies to: 60-61
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/mevblocker/endpointsProtection.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/mevblocker/orderflow-originators/Endpoints.md(3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: pretf00d
PR: cowprotocol/docs#512
File: docs/mevblocker/concepts/gas_rebates.md:16-16
Timestamp: 2025-06-30T14:12:14.869Z
Learning: When referring to MEV Blocker or other products/services in documentation, use "that" instead of "who" as the relative pronoun (e.g., "MEV Blocker is the only RPC that has..." not "MEV Blocker is the only RPC who has...") because products are not people.
docs/mevblocker/orderflow-originators/Endpoints.md (1)
Learnt from: pretf00d
PR: #512
File: docs/mevblocker/concepts/gas_rebates.md:16-16
Timestamp: 2025-06-30T14:12:14.869Z
Learning: When referring to MEV Blocker or other products/services in documentation, use "that" instead of "who" as the relative pronoun (e.g., "MEV Blocker is the only RPC that has..." not "MEV Blocker is the only RPC who has...") because products are not people.
🔇 Additional comments (1)
docs/mevblocker/orderflow-originators/Endpoints.md (1)
9-9: Image path verified in repo
The filestatic/img/mevblocker/endpointsProtection.pngexists at the correct, case-sensitive location—this will unblock the Linux build pipeline.
|
Merging to fix build and allow new changes to flow through. |
2 participants
Description
Build has been failing due to file name case mismatch.
Not a problem building locally on macos due to lack of file system case sensitivity, but failing on Vercel that builds on Linux
Changes
Endpoints_protection.pngtoendpointsProtection.pngTesting
Summary by CodeRabbit