Skip to content

Commit

Permalink
chore: remove docs and update readme (#151)
Browse files Browse the repository at this point in the history
## Description

This PR removes documentation that is otherwise a duplication of that
found in the [documentation](https://github.com/cowprotocol/docs)
repository, and is therefore redundant. As well, it updates the
repository's `README.md` to let observers know that some construction is
underway.

## Test Plan

1. Verify document links are not 404.
2. Verify formatting of important note in `README.md`.

## Related Issues

Closes #100
  • Loading branch information
mfw78 authored Jun 4, 2024
1 parent cc8061f commit 8740bf0
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 35 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
> [!IMPORTANT]
> This repository is in the process of being migrated to the [Foundry](https://getfoundry.sh) Ethereum application development environment. Developers wishing to integrate and/or develop on the CoW Protocol smart contracts with hardhat should refer to tag [`v1.6.0`](https://github.com/cowprotocol/contracts/releases/tag/v1.6.0) [Browse files](https://github.com/cowprotocol/contracts/tree/1d673839a7402bdb2949175ebb61e8b5c4f39ecb).
# CoW Protocol

This repository contains the Solidity smart contract code for the **CoW Protocol** (formerly known as **Gnosis Protocol**).

For more documentation on how the protocol works on a smart contract level, see the [documentation pages](docs/index.md).
Extensive [documentation](https://docs.cow.fi/cow-protocol/reference/contracts/core) is available detailing how the protocol works on a smart contract level.

## Getting Started

Expand Down
25 changes: 0 additions & 25 deletions docs/architecture.md

This file was deleted.

Binary file removed docs/images/architecture.png
Binary file not shown.
9 changes: 0 additions & 9 deletions docs/index.md

This file was deleted.

0 comments on commit 8740bf0

Please sign in to comment.