An open API service indexing awesome lists of open source software.

https://github.com/aave/docs-gho


https://github.com/aave/docs-gho

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README

          

# GHO Document Hub

This repository contains all the documentation for GHO,a decentralized overcollateralized stablecoin that is fully backed, transparent and native to the Aave Protocol. The docs [website](docs.gho.xyz) has been built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Documentation

The GHO documentation covers a general overview of concepts, and developer docs.

### Concepts

These pages cover the core concepts to help users learn the basics of GHO. This includes:

- What is GHO?
- Why GHO?
- How GHO works (Facilitators, interest and discount rate models, and more)
- Fundamentals (how to interact with GHO, FlashMinting)

### Developer Docs

Developers can look into the technical implementation of GHO, smart contracts, how to integrate GHO, and find the deployed contracts addresses.

### Other Resources

Alongside these main sections, users can find FAQs, audits, a glossary and the techpaper.

## Installation

Install and run the GHO documentation.

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.