-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
3,265 additions
and
258 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Documentation for the Enzyme API and SDK | ||
|
||
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"name": "@enzymefinance/api-sdk-documentation", | ||
"version": "0.0.0", | ||
"type": "module", | ||
"scripts": { | ||
"dev": "vocs dev", | ||
"build": "vocs build", | ||
"preview": "vocs preview" | ||
}, | ||
"dependencies": { | ||
"react": "latest", | ||
"react-dom": "latest", | ||
"vocs": "latest" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Enzyme API - Overview |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Getting Started | ||
|
||
Add the Enzyme SDK to your TypeScript project: | ||
|
||
```bash | ||
pnpm add @enzymefinance/sdk | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Overview | ||
|
||
The Enzyme API and the Enzyme SDK allow you to interact with the Enzyme protocol. | ||
|
||
## Enzyme API | ||
|
||
The Enzyme API provides endpoints to _read_ data related to Enzyme vaults. | ||
|
||
## Enzyme SDK | ||
|
||
The Enzyme SDK is a TypeScript library that allows you to interact with the Enzyme protocol on-chain. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Enzyme SDK - Overview |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"compilerOptions": { | ||
"target": "ES2020", | ||
"useDefineForClassFields": true, | ||
"lib": ["ES2020", "DOM", "DOM.Iterable"], | ||
"module": "ESNext", | ||
"skipLibCheck": true, | ||
|
||
/* Bundler mode */ | ||
"moduleResolution": "bundler", | ||
"allowImportingTsExtensions": true, | ||
"resolveJsonModule": true, | ||
"isolatedModules": true, | ||
"noEmit": true, | ||
"jsx": "react-jsx", | ||
|
||
/* Linting */ | ||
"strict": true, | ||
"noUnusedLocals": true, | ||
"noUnusedParameters": true, | ||
"noFallthroughCasesInSwitch": true | ||
}, | ||
"include": ["**/*.ts", "**/*.tsx"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
import { defineConfig } from "vocs"; | ||
|
||
export default defineConfig({ | ||
title: "Enzyme API/SDK", | ||
rootDir: "src", | ||
sidebar: [ | ||
{ | ||
text: "Overview", | ||
link: "/", | ||
}, | ||
{ | ||
text: "Getting Started", | ||
link: "/getting-started", | ||
}, | ||
{ | ||
text: "API", | ||
collapsed: false, | ||
items: [ | ||
{ | ||
text: "Overview", | ||
link: "/api/overview", | ||
}, | ||
], | ||
}, | ||
{ | ||
text: "SDK", | ||
collapsed: false, | ||
items: [ | ||
{ | ||
text: "Overview", | ||
link: "/sdk/overview", | ||
}, | ||
], | ||
}, | ||
], | ||
socials: [ | ||
{ | ||
icon: "discord", | ||
link: "https://discord.enzyme.finance", | ||
}, | ||
{ | ||
icon: "github", | ||
link: "https://github.com/enzymefinance/sdk", | ||
}, | ||
{ | ||
icon: "x", | ||
link: "https://twitter.com/enzymefinance", | ||
}, | ||
], | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.