feat: add the SDK section with its API reference

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: Build
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
+        with:
+          node-version: 24
+      - run: npm ci
+      - run: npm run build

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .vitepress/dist
 .vitepress/cache
+sdk/api

.npmrc

@@ -0,0 +1,3 @@
+ignore-scripts=true
+save-exact=true
+min-release-age=7

.vitepress/config.ts

@@ -1,17 +1,32 @@
+import { readFileSync } from "node:fs";
 import { defineConfig } from "vitepress";
 
+const apiSidebar = JSON.parse(
+  readFileSync(
+    new URL("../sdk/api/typedoc-sidebar.json", import.meta.url),
+    "utf-8",
+  ),
+);
+apiSidebar[0].text = "@loktin/sdk";
+
 export default defineConfig({
   title: "Loktin Docs",
   description:
-    "Plan. Lock In. Earn. Documentation for the Loktin savings platform.",
+    "Plan. Lock In. Save. Documentation for the Loktin savings platform.",
   cleanUrls: true,
   lang: "en-US",
   lastUpdated: true,
 
+  transformPageData(pageData) {
+    if (pageData.relativePath.startsWith("sdk/api/")) {
+      pageData.frontmatter.editLink = false;
+    }
+  },
+
   head: [
     ["link", { rel: "icon", type: "image/x-icon", href: "/favicon.ico" }],
     ["meta", { property: "og:title", content: "Loktin Docs" }],
-    ["meta", { property: "og:description", content: "Plan. Lock In. Earn." }],
+    ["meta", { property: "og:description", content: "Plan. Lock In. Save." }],
     ["meta", { name: "theme-color", content: "#0B1E1E" }],
   ],
 
@@ -23,68 +38,81 @@ export default defineConfig({
       { text: "Home", link: "/" },
       { text: "Get Started", link: "/getting-started" },
       { text: "Primitives", link: "/primitives/plans" },
+      { text: "SDK", link: "/sdk/" },
       // { text: "Architecture", link: "/architecture/overview" },
       { text: "App", link: "https://loktin.xyz" },
     ],
 
-    sidebar: [
-      {
-        text: "Overview",
-        items: [
-          { text: "Introduction", link: "/introduction" },
-          { text: "Getting Started", link: "/getting-started" },
-        ],
-      },
-      {
-        text: "Savings Primitives",
-        collapsed: false,
-        items: [
-          { text: "Bill Plans", link: "/primitives/plans" },
-          { text: "Target Savings", link: "/primitives/target-savings" },
-          { text: "Locked In", link: "/primitives/locked-in" },
-          { text: "Spend & Save", link: "/primitives/spend-save" },
-        ],
-      },
-      {
-        text: "Coming Soon",
-        collapsed: false,
-        items: [
-          { text: "Earn via Blend", link: "/coming-soon/blend-yield" },
-          { text: "ZK Privacy Layer", link: "/coming-soon/zk-privacy" },
-        ],
-      },
-      // {
-      //   text: "Architecture",
-      //   collapsed: true,
-      //   items: [
-      //     { text: "Overview",            link: "/architecture/overview" },
-      //     { text: "Smart Contracts",     link: "/architecture/smart-contracts" },
-      //     { text: "Keeper Service",      link: "/architecture/keeper-service" },
-      //     { text: "Frontend",            link: "/architecture/frontend" },
-      //     { text: "Authorization Model", link: "/architecture/authorization" },
-      //   ],
-      // },
-      {
-        text: "How To",
-        collapsed: true,
-        items: [
-          { text: "Create a Plan", link: "/how-to/create-plan" },
-          { text: "Set Up Target Savings", link: "/how-to/target-savings" },
-          { text: "Lock In USDC", link: "/how-to/lock-in" },
-          { text: "Enroll in Spend & Save", link: "/how-to/spend-save" },
-          { text: "Withdraw Funds", link: "/how-to/withdraw" },
-        ],
-      },
-      {
-        text: "Reference",
-        collapsed: true,
-        items: [
-          // { text: "Contract IDs", link: "/reference/contract-ids" },
-          { text: "FAQ", link: "/reference/faq" },
-          { text: "Glossary", link: "/reference/glossary" },
-        ],
-      },
-    ],
+    sidebar: {
+      "/sdk/": [
+        {
+          text: "SDK",
+          items: [{ text: "Overview", link: "/sdk/" }],
+        },
+        {
+          text: "API reference",
+          items: apiSidebar,
+        },
+      ],
+      "/": [
+        {
+          text: "Overview",
+          items: [
+            { text: "Introduction", link: "/introduction" },
+            { text: "Getting Started", link: "/getting-started" },
+          ],
+        },
+        {
+          text: "Savings Primitives",
+          collapsed: false,
+          items: [
+            { text: "Bill Plans", link: "/primitives/plans" },
+            { text: "Target Savings", link: "/primitives/target-savings" },
+            { text: "Locked In", link: "/primitives/locked-in" },
+            { text: "Spend & Save", link: "/primitives/spend-save" },
+          ],
+        },
+        {
+          text: "Coming Soon",
+          collapsed: false,
+          items: [
+            { text: "Earn via Blend", link: "/coming-soon/blend-yield" },
+            { text: "ZK Privacy Layer", link: "/coming-soon/zk-privacy" },
+          ],
+        },
+        // {
+        //   text: "Architecture",
+        //   collapsed: true,
+        //   items: [
+        //     { text: "Overview",            link: "/architecture/overview" },
+        //     { text: "Smart Contracts",     link: "/architecture/smart-contracts" },
+        //     { text: "Keeper Service",      link: "/architecture/keeper-service" },
+        //     { text: "Frontend",            link: "/architecture/frontend" },
+        //     { text: "Authorization Model", link: "/architecture/authorization" },
+        //   ],
+        // },
+        {
+          text: "How To",
+          collapsed: true,
+          items: [
+            { text: "Create a Plan", link: "/how-to/create-plan" },
+            { text: "Set Up Target Savings", link: "/how-to/target-savings" },
+            { text: "Lock In USDC", link: "/how-to/lock-in" },
+            { text: "Enroll in Spend & Save", link: "/how-to/spend-save" },
+            { text: "Withdraw Funds", link: "/how-to/withdraw" },
+          ],
+        },
+        {
+          text: "Reference",
+          collapsed: true,
+          items: [
+            // { text: "Contract IDs", link: "/reference/contract-ids" },
+            { text: "FAQ", link: "/reference/faq" },
+            { text: "Glossary", link: "/reference/glossary" },
+          ],
+        },
+      ],
+    },
 
     socialLinks: [
       { icon: "github", link: "https://github.com/Mackenzie-OO7/loktin" },
@@ -101,7 +129,7 @@ export default defineConfig({
 
     outline: { level: [2, 3], label: "On this page" },
     editLink: {
-      pattern: "https://github.com/Mackenzie-OO7/loktin/edit/main/docs/:path",
+      pattern: "https://github.com/Lokt-In/loktin-docs/edit/main/:path",
       text: "Edit on GitHub",
     },
   },

index.md

@@ -3,7 +3,7 @@ layout: home
 
 hero:
   name: "Loktin"
-  text: "Plan. Lock In. Earn."
+  text: "Plan. Lock In. Save."
   tagline: "Auto-pay bills, hit savings goals, lock USDC for fixed terms, or stash a slice of every spend and earn yield via Blend."
   actions:
     - theme: brand