cowprotocol / cowprotocol/docs
feat: solving auctions tutorial
Open
@fhenneke is already working on this.
Since Dec 18, 2023.
documentation
E:2.1: Documentation and Tutorials
team:solvers
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 32
- PR merge metrics
- No merged PRs in 30d
Description
Problem
Trying to start to run a solver, or write a solver is already a very difficult problem - and out of date documentation doesn't help 🙃
Suggested solution
Rewrite the "tutorials" section for solvers, also taking into account the new driver/solver colocation architecture.
Alternatives considered
N/A
Additional context
Considerable work has been done consolidating the section from the old documents. Work in this area can be found at https://github.com/cowprotocol/docs-v2/tree/main/docs/cow-protocol/tutorials/solvers.
Acceptance criteria
- Inaccurate information removed from documentation
- Basic tutorial of starting a solver
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.