Skip to content

Commit

Permalink
Merge pull request #106 from defactor-com/restructure-docs
Browse files Browse the repository at this point in the history
Update pools category structure
  • Loading branch information
xavier506 committed Jun 5, 2024
2 parents 870aefa + 643dda6 commit b938344
Show file tree
Hide file tree
Showing 17 changed files with 21 additions and 15 deletions.
6 changes: 3 additions & 3 deletions docs/introduction/software-development-kit.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can find the source code for this repository in [github.com/defactor-com/sdk

- Support for cjs, es, and esm modules.
- Developed using TypeScript for enhanced type safety and clarity.
- Seamless integration with [`ERC20CollateralPool`](/docs/pools/back-end-api/sdk/collateral-pool) and [`Pools`](/docs/pools/back-end-api/sdk/counterparty-pool).
- Seamless integration with [`ERC20CollateralPool`](/docs/pools/back-end/sdk/collateral-pool) and [`Pools`](/docs/pools/back-end/sdk/counterparty-pool).
- Well-defined interfaces that accurately model the Defactor contracts for easy interaction and integration.

This library is built on top of [`ether@6.x.x`](https://docs.ethers.org/v6/api/contract/) to provide a simple and easy to use interface to interact with the Defactor contracts.
Expand Down Expand Up @@ -83,8 +83,8 @@ console.log(liquidationProtocolFee); // 5n
### Integrations with the contracts

- Pools
- [`Counterparty Pool`](/docs/pools/back-end-api/sdk/counterparty-pool).
- [`Collateral Pool`](/docs/pools/back-end-api/sdk/collateral-pool)
- [`Counterparty Pool`](/docs/pools/back-end/sdk/counterparty-pool).
- [`Collateral Pool`](/docs/pools/back-end/sdk/collateral-pool)

## Examples

Expand Down

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Pools",
"label": "API Endpoints",
"position": 1,
"link": {
"type": "generated-index",
Expand Down
6 changes: 6 additions & 0 deletions docs/pools/back-end/api/counterpartyPools/graphql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Endpoints List GraphQL API
sidebar_position: 2
---

Coming Soon...
6 changes: 6 additions & 0 deletions docs/pools/back-end/api/counterpartyPools/restful.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Endpoints List RESTful API
sidebar_position: 1
---

Coming Soon...
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Counterparty Pool Contract"
sidebar_position: 1
---

The [Defactor SDK](/docs/introduction/software-development-kit) provides utilities and classes to seamless interaction with the Defactor contracts. In this specific section, the focus is in the [CounterParty Pool Contract](/docs/pools/smart-contracts/erc20-collateral-pool-contract/smart-contract-erc20-collateral-pool/) and `Pools` class, which implements the fundamental methods to interact with the contract in question.
The [Defactor SDK](/docs/introduction/software-development-kit) provides utilities and classes to seamless interaction with the Defactor contracts. In this specific section, the focus is in the [CounterParty Pool Contract](/docs/pools/smart-contracts/counterparty-pools-contract/counterparty-pools-smart-contract) and `Pools` class, which implements the fundamental methods to interact with the contract in question.

## Constants

Expand Down
2 changes: 1 addition & 1 deletion docs/pools/front-end-ui/react-migration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Migrating Defactor's Front-end to React
title: Front-End Migration to React
sidebar_position: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: smart-contract-erc20-collateral-pool-example
id: counterparty-pools-smart-contract-example
title: Example
sidebar_position: 3
tags:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: smart-contract-erc20-collateral-pool
id: counterparty-pools-smart-contract
title: Introduction
sidebar_position: 1
tags:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: smart-contract-erc20-collateral-pool-technical-aspects
id: counterparty-pools-technical-aspects
title: Technical Aspects
sidebar_position: 2
tags:
Expand Down

0 comments on commit b938344

Please sign in to comment.