Skip to content

Commit

Permalink
correcting broken links again
Browse files Browse the repository at this point in the history
  • Loading branch information
frkralj committed Sep 29, 2023
1 parent eef0107 commit a143d41
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 17 deletions.
25 changes: 25 additions & 0 deletions docs/contracts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Introduction
sidebar_position: 1
---

# Introduction

The Mangrove is an [EVM-compatible](https://ethereum.org/en/developers/docs/scaling/sidechains/#evm-compatibility) order book-based exchange protocol (a [DEX](https://ethereum.org/en/defi/)), in which offers can be bound to a [smart contract](https://ethereum.org/en/smart-contracts/).

The order book of Mangrove lists promises to trade, instead of locked commitments.

* Offer makers add [liquidity promises](./background/offer-maker.md) to Mangrove. They own offers in %%offer lists|offer-list%% and manage contracts that react to [offer execution](./technical-references/taking-and-making-offers/reactive-offer/executing-offers.md).
* Takers go to Mangrove to [find liquidity](./background/offer-maker.md) by executing offers already in Mangrove.
* [Governance](./technical-references/governance-parameters/README.md) adjusts Mangrove parameters, sets fees, and opens and closes new markets.

> 💡
> For non technical information about Mangrove, check out the [Concepts](../general.md) section.
## Where do I start?

A good entry-point to the developer documentation for Mangrove protocol is the [Overview of Mangrove](./technical-references/overview.md) in the Technical Reference section.

## Where can I join the community?

The Mangrove project is open source. Follow and contribute on [GitHub](https://github.com/mangrovedao/), and join the [Mangrove Discord](https://discord.gg/rk9Qthz5YE).
23 changes: 6 additions & 17 deletions docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,10 @@ sidebar_position: 1

# Welcome to the Developers Doc

The Mangrove is an [EVM-compatible](https://ethereum.org/en/developers/docs/scaling/sidechains/#evm-compatibility) order book-based exchange protocol (a [DEX](https://ethereum.org/en/defi/)), in which offers can be bound to a [smart contract](https://ethereum.org/en/smart-contracts/).
In here, we will cover in details:
* the [core protocol](./contracts/README.md)
* the [Strategies Library](./strat-lib/README.md)
* our [SDK](./SDK/README.md)
* [Keeper and Cleaning bots](./keeper-bots/).

The order book of Mangrove lists promises to trade, instead of locked commitments.

* Offer makers add [liquidity promises](./contracts/background/offer-maker.md) to Mangrove. They own offers in %%offer lists|offer-list%% and manage contracts that react to [offer execution](./contracts/technical-references/taking-and-making-offers/reactive-offer/executing-offers.md).
* Takers go to Mangrove to [find liquidity](./contracts/background/offer-maker.md) by executing offers already in Mangrove.
* [Governance](./contracts/technical-references/governance-parameters/README.md) adjusts Mangrove parameters, sets fees, and opens and closes new markets.

> 💡
> For non technical information about Mangrove, check out the [Concepts](./general.md) section.
## Where do I start?

A good entry-point to the developer documentation for Mangrove protocol is the [Overview of Mangrove](./contracts/technical-references/overview.md) in the Technical Reference section.

## Where can I join the community?

The Mangrove project is open source. Follow and contribute on [GitHub](https://github.com/mangrovedao/), and join the [Mangrove Discord](https://discord.gg/rk9Qthz5YE).
We suggest you start by reading [this introduction](./contracts/README.md)!

0 comments on commit a143d41

Please sign in to comment.