cowprotocol / cowprotocol/docs

chore: Add anchor to contract deployment addresses

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

Background

We list many of the different smart contracts we deployed and their default addresses in a dedicated page.
Sometimes we need to reference this page for the deployment address of a specific contract.

It would be great if I could directly link to the specific contract rather than linking to the generic page and telling the user to find the right contract in there. For example, the URL could look like this:
https://docs.cow.fi/cow-protocol/reference/contracts/periphery#composable-cow

Acceptance criteria
  • I can create an URL that points to the addresses for a specific smart contract

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 at the dedicated periphery contracts page linked in the issue and inspect how each deployed contract and address is presented. Make the specific contract address section linkable, then verify that the example URL ending in #composable-cow reaches it. Done means a contract-specific URL points directly to its address.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.