Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp protect docs with new settings guide #578

Merged
merged 4 commits into from
Sep 18, 2024
Merged

Conversation

sketsdever
Copy link
Collaborator

Settings

  • Created a new settings page with every custom query parameter and setting you can add to protect. In the past most of these have lived in the MEV-Share page but (1) we are adding new mempool params that are not MEV-Share specific and need a good home, and (2) some of the MEV-Share settings like refunds also affect gas fee refunds so they should live at the top level
  • Added info on the new mempool params to the new settings page
  • Updated how we describe some of the existing settings (eg. clarify that the refund parameter affects gas fee refunds, not just mev share refunds)

Other polish

  • Updated some of the copy on the protect quick start and overview pages (eg. we had slightly different descriptions of the key benefits on each page, now they are the same)
  • Updated the title of the MEV-Share page to "MEV refunds" to be more consistent with gas fee refunds and because in the protect section of the docs we should be naming things based on user facing features not the underlying protocols (which have their own pages elsewhere)
  • Updated some of the copy in the MEV-Share page to be more readable and consistent with the gas fee refunds page
  • Deleted settings from MEV-Share page that have moved to the settings page, changed the examples we have on the MEV-Share page to focus on privacy configurations (which is specific to MEV refunds and worth calling out on this sub page)

If I feel inspired I might also expand on the now-reduced MEV refunds page to include sections like we have on the gas refunds page. I think this is enough for now though.

Copy link

vercel bot commented Sep 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flashbots-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 7:01pm

Copy link
Member

@bertmiller bertmiller left a comment

Choose a reason for hiding this comment

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

lgtm

@sketsdever sketsdever merged commit 3de565d into main Sep 18, 2024
3 checks passed
@sketsdever sketsdever deleted the sheak/protect-settings branch September 18, 2024 19:09
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.

2 participants