docs

kyscott18 · Sep 27, 2023 · b286801 · b286801
1 parent 89db9c0
commit b286801
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 9 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -4,19 +4,22 @@ import { defineConfig } from "vitepress";
 export default defineConfig({
   title: "Reverse Mirage",
   description: "Application level typescript utilities for Ethereum",
-  head: [["script", { src: "/_vercel/insights/script.js" }]],
+  head: [
+    ["script", { src: "https://cdn.vercel-insights.com/v1/script.debug.js" }],
+  ],
   themeConfig: {
     search: {
       provider: "local",
     },
 
     sidebar: [
+      { text: "Introduction", link: "/" },
       {
-        text: "Introduction",
+        text: "Overview",
         items: [
-          { text: "Getting started", link: "/" },
-          { text: "Benchmarks", link: "benchmark" },
-          { text: "Examples", link: "example" },
+          { text: "Getting started", link: "/start" },
+          { text: "Benchmarks", link: "/benchmark" },
+          { text: "Examples", link: "/example" },
         ],
       },
       {
@@ -28,7 +31,7 @@ export default defineConfig({
             items: [
               {
                 text: "createERC20",
-                link: "erc20/createERC20",
+                link: "/erc20/createERC20",
               },
               {
                 text: "createERC20Amount",

diff --git a/docs/benchmark.md b/docs/benchmark.md
@@ -9,6 +9,6 @@
 
 ## Bundle Size
 
-`reverse-mirage`: **5.17 kB**
+`reverse-mirage`: **5.12 kB**
 
 `@uniswap/sdk-core`: **53.4 kB**
diff --git a/docs/example.md b/docs/example.md
@@ -5,7 +5,7 @@ A [beta interface](https://github.com/kyscott18/reverse-mirage/tree/v1/examples/
 ## Features
 
 * Runs on an anvil local node
-* Query balances
+* Query balances, automatically update after transactions
 * Transfer test tokens
 * Reset node state from interface
 

diff --git a/docs/index.md b/docs/index.md
@@ -10,7 +10,7 @@ This documentation is still under active development.
 
 ## Features
 
-- ✅ 10x-100x faster, 10.3x smaller than [`@uniswap/sdk-core`](https://github.com/uniswap/sdk-core)
+- ✅ 10x-100x faster, 10.4x smaller than [`@uniswap/sdk-core`](https://github.com/uniswap/sdk-core)
 - ✅ Abstactions for most commonly used token standards
 - ✅ Extensible to build apps and libraries
 - ✅ Seamless extension to [Viem](https://github.com/wagmi-dev/viem)

diff --git a/docs/start.md b/docs/start.md
@@ -0,0 +1,23 @@
+# Getting Started
+
+## Overview
+
+what we are trying to do and how.
+
+you should know viem well before using this.
+
+## Entities
+
+### Ethereum contracts
+
+### Derived from Ethereum
+
+## Utilities
+
+## Read actions
+
+## Write actions
+
+## Extras
+
+### Chains