cowprotocol / cowprotocol/docs

bug: mev blocker docs inconsistencies

Open
#354 0 comments 0 reactions 3 assignees View on GitHub

@cowmarketing is already working on this.

Since Apr 10, 2024.

bug
Dominant language
TypeScript
Stars
5
Forks
32
PR merge metrics
No merged PRs in 30d

Description

Problem

There are a couple of problems with the MEV Blocker docs that require remedy:

  1. Use of "Overview" in a section. This is against the style used throughout the docs.
  2. Duplication of content from learn.cow.fi. It is strongly suggested that this should live in one place only.
  3. There is some duplication of content within the documentation itself (such as MEV Blocker and then within the concepts), and also duplicated documentation on the RPC endpoints and their description. Duplication MUST be avoided.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.