cowprotocol / cowprotocol/learn

chore: More context on `Yield Farming` page

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

Nobody has claimed this yet.

documentation
Dominant language
Svelte
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Background

Other than most tutorials https://beta.docs.cow.fi/cow-protocol/tutorials/integrations/programmatic/yield_farming seems to assume you have a lot of context. Since this requires knowledge about the programmatic order framework we should at the very least have a link to it and give some broad overview on its concept when we suggest to solve the given problem with it.
Also links to the mentioned zap (no idea what that is) and to the ExtensibleFallbackHandler would be useful.

Contributor guide

No contributing guide indexed for this repository

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

Open the Yield Farming tutorial at the linked beta.docs.cow.fi URL and review the references to the programmatic order framework, zap, and ExtensibleFallbackHandler. Add a broad overview and links for the framework, zap, and ExtensibleFallbackHandler; the page is done when readers can follow these concepts and resources without needing the missing context.

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
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.