Skip to content

Commit

Permalink
chore: scaffold documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
iherger committed Jan 29, 2024
1 parent b85a6b1 commit 4c40fb9
Show file tree
Hide file tree
Showing 12 changed files with 3,265 additions and 258 deletions.
3 changes: 3 additions & 0 deletions docs/README.md
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.
15 changes: 15 additions & 0 deletions docs/package.json
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"
}
}
1 change: 1 addition & 0 deletions docs/src/pages/api/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Enzyme API - Overview
7 changes: 7 additions & 0 deletions docs/src/pages/getting-started.mdx
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
```
11 changes: 11 additions & 0 deletions docs/src/pages/index.mdx
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.
1 change: 1 addition & 0 deletions docs/src/pages/sdk/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Enzyme SDK - Overview
24 changes: 24 additions & 0 deletions docs/tsconfig.json
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"]
}
50 changes: 50 additions & 0 deletions docs/vocs.config.ts
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",
},
],
});
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"test": "vitest",
"test:coverage": "vitest --coverage",
"typecheck": "tsc --build tsconfig.json",
"documentation": "pnpm run --filter @enzymefinance/api-sdk-documentation dev",
"format": "biome format --write . && biome check --apply-unsafe .",
"lint": "biome check ."
},
Expand Down
Loading

0 comments on commit 4c40fb9

Please sign in to comment.