diff --git a/DEVELOPING.md b/DEVELOPING.md index cbfdfb38..27f35549 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -6,6 +6,13 @@ This is a more in depth description of the Dai core contracts. The previous iteration of Dai was called Single Collateral Dai (SCD), or `sai`, and is found at https://github.com/makerdao/sai +## Documentation + +- **[DSS (Mintlify)](https://mintlify.wiki/sky-ecosystem/dss)** — Reference for this repository’s contract structure: core accounting (Vat), liquidations, rates (Jug, Pot), settlement (Vow, End), and how the pieces fit together. +- **[Sky Protocol developer portal](https://developers.skyeco.com/)** — Broader ecosystem documentation (tokens, vaults, governance, peg modules, bridges, etc.). Use it alongside this guide when you need product- or integration-level detail rather than low-level `dss` layout. + +The [wiki](https://github.com/makerdao/dss/wiki) and this file remain the in-repo narrative; Mintlify is useful for navigating contracts by name and subsystem. + ## Tooling diff --git a/README.md b/README.md index 342886e4..e042e92b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ whitepaper. ## Additional Documentation -`dss` is also documented in the [wiki](https://github.com/makerdao/dss/wiki) and in [DEVELOPING.md](https://github.com/makerdao/dss/blob/master/DEVELOPING.md) +`dss` is also documented in the [wiki](https://github.com/makerdao/dss/wiki) and in [DEVELOPING.md](https://github.com/makerdao/dss/blob/master/DEVELOPING.md). + +**Contract structure and core interfaces:** the Sky ecosystem publishes [DSS documentation](https://mintlify.wiki/sky-ecosystem/dss) (built with [Mintlify](https://mintlify.com)), including the Vat, liquidations, stability fees, Dai Savings Rate, and settlement. + +**Protocol and product documentation:** for tokens, vaults, governance, bridges, and other Sky-facing integration topics, see the [Sky Protocol developer portal](https://developers.skyeco.com/). ## Design Considerations