search

osmosis-labs / isotonic

Smart Contracts for the Lendex Protocol
MIT License
1 stars 0 forks source link

Update READMEs #36

Closed uint closed 2 years ago

uint commented 2 years ago

As of writing this, both lendex-token and lendex-market READMEs are out of date.lendex-token only has a template README.

ethanfrey commented 2 years ago

Let's remove README.md for now unless they have useful information.

Before 1.0 (public release), we will produce nice, "medium article"-like docs to explain the design. Purpose is to allow other people to easily take a look at how the code works and gain confidence it is written properly.

General design and business purpose for this contract should be explained.

ethanfrey commented 2 years ago

For documenting APIs, we can link to rustdoc generated from the crates, which should be easily readable by devs. Ideas about how to auto-generate some docs from JSON schema (see https://github.com/CosmWasm/cw-plus/issues/573)

This is very important for other repos, not for this one so much.

ethanfrey commented 2 years ago

We can also produce a docs website that contains the design targeted to business users. Many defi protocols have something far away from the code as an intro. eg. https://compound.finance/docs

ueco-jb commented 2 years ago

I'd still keep some tech-debty issue to add some proper "medium-like" docs.

uint commented 2 years ago

I'd still keep some tech-debty issue to add some proper "medium-like" docs.

Fair. I opened a new one: https://github.com/confio/isotonic/issues/95