Skip to content

Commit

Permalink
chore: reorganize
Browse files Browse the repository at this point in the history
  • Loading branch information
iherger committed Jan 29, 2024
1 parent 13267c0 commit 33bc15c
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 5 deletions.
File renamed without changes.
File renamed without changes.
17 changes: 17 additions & 0 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: landing
---

import { HomePage } from 'vocs/components'

<HomePage.Root>
<HomePage.Logo />
<HomePage.Tagline>On-chain asset management made easy.</HomePage.Tagline>
<HomePage.Description>Interact with your Enzyme vault using the Enzyme API and Enzyme SDK.</HomePage.Description>
<HomePage.Buttons>
<HomePage.Button href="/overview" variant="accent">Get started</HomePage.Button>
<HomePage.Button href="https://github.com/enzymefinance/sdk">GitHub</HomePage.Button>
</HomePage.Buttons>
</HomePage.Root

>
12 changes: 10 additions & 2 deletions docs/src/pages/index.mdx → docs/pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,16 @@ 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.
The Enzyme API provides endpoints to _read_ data related to Enzyme vaults, e.g.

- NAV and current share price,
- Portfolio,
- Historical share prices.

## Enzyme SDK

The Enzyme SDK is a TypeScript library that allows you to interact with the Enzyme protocol on-chain.
The Enzyme SDK is a TypeScript library that allows you to interact with the Enzyme protocol on-chain, e.g.

- Deposit into a vault,
- Swap assets,
- Reconfigure a vault.
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/vocs.config.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { defineConfig } from "vocs";

export default defineConfig({
title: "Enzyme API/SDK",
rootDir: "src",
title: "Enzyme Finance",
rootDir: ".",
sidebar: [
{
text: "Overview",
link: "/",
link: "/overview",
},
{
text: "Getting Started",
Expand Down

0 comments on commit 33bc15c

Please sign in to comment.