cowprotocol / cowprotocol/docs

"arbitrate" an auction - unclear meaning

Open
#332 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

https://github.com/cowprotocol/docs/blob/2230893e6ec40e78b5ce464836577bf7da78076c/docs/cow-protocol/tutorials/arbitrate/README.mdx#L1C1-L1C23

It could be a CS term, but at least from the auction theory viewpoint, the term "arbitration" is never used. So it is a bit unclear what we mean by that. Running the auction? Selecting the winner of the auction?

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.

Research direction

Start with docs/cow-protocol/tutorials/arbitrate/README.mdx at the linked first line and review how "arbitrate" is used in the tutorial. Confirm the intended meaning with project maintainers, then update the terminology or explanation so readers can tell whether it means running the auction or selecting its winner.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.