Skip to content

Commit

Permalink
Small edits of developer docs (#216)
Browse files Browse the repository at this point in the history
  • Loading branch information
espendk authored Jan 16, 2024
1 parent d6f29f4 commit 09b601a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/developers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Mangrove Developers documentation section exists to help developers:
* learn about Mangrove [core protocol](./contracts/README.md),
* understand how trading [strategies](./strat-lib/README.md) can be created and plugged in,
* use and integrate our [SDK](./SDK/README.md),
* set up [Keeper and Cleaning bots](./keeper-bots/README.md).
* set up [Keeper bots](./keeper-bots/README.md).


We suggest you start by reading [this introduction](./contracts/README.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Mangrove's order book 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.
* [Governance](./technical-references/governance-parameters/README.md) adjusts Mangrove parameters, sets fees, and opens and closes markets.

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

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

## Where can I join the community?

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/contracts/technical-references/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Mangrove contract is depicted in the middle, with the three most important a

* [Offer makers](#makers) add [liquidity promises](../background/offer-maker.md) to Mangrove.

* [Takers](#takers) use Mangrove to [find liquidity](../background/offer-taker.md) by executing offers published on Mangrove.
* [Takers](#takers) use Mangrove to [find liquidity](../background/offer-taker.md) by executing market orders and thereby executing offers published on Mangrove.

* Cleaners identify offers that will fail to deliver the promised liquidity and [clean](../../keeper-bots/guides/use-borrowed-funds-for-cleaning) them, i.e. remove them from the book in exchange for a bounty.

Expand Down

0 comments on commit 09b601a

Please sign in to comment.