cowprotocol / cowprotocol/docs

feat: barn

Open
#206 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

Problem

We never explain what Barn is, why it's needed and when/if it should be used.

Suggested solution

Add a new page for barn. I don't see a fitting location, so maybe we should also create an infrastructure page and have this page at Technical reference > Infrastructure > Barn.

Alternatives considered

Just add it as a line in Technical reference > Core > Definitions

Acceptance criteria
  • new barn page

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

Review the existing Technical reference navigation and pages, especially Core > Definitions, to determine where Barn belongs. Done means a new Barn page explains what it is, why it is needed, and when or whether it should be used, with the page linked in the chosen location.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.