From a98ad880abf16c9f3d815588782aadaff4715ff4 Mon Sep 17 00:00:00 2001
From: Nathan_akin <85641756+akintewe@users.noreply.github.com>
Date: Mon, 30 Sep 2024 13:25:46 +0100
Subject: [PATCH 1/2] added required files

---
 docs/404.md                   |  8 ++++++++
 docs/pages/example.md         |  8 ++++++++
 docs/pages/getting-started.md |  8 ++++++++
 docs/pages/index.md           |  9 +++++++++
 package.json                  | 19 +++++++++++++++++++
 theme.config.tsx              | 18 ++++++++++++++++++
 tsconfig.json                 | 19 +++++++++++++++++++
 vocs.config.ts                | 25 +++++++++++++++++++++++++
 vocs.d.ts                     |  3 +++
 9 files changed, 117 insertions(+)
 create mode 100644 docs/404.md
 create mode 100644 docs/pages/example.md
 create mode 100644 docs/pages/getting-started.md
 create mode 100644 docs/pages/index.md
 create mode 100644 package.json
 create mode 100644 theme.config.tsx
 create mode 100644 tsconfig.json
 create mode 100644 vocs.config.ts
 create mode 100644 vocs.d.ts

diff --git a/docs/404.md b/docs/404.md
new file mode 100644
index 00000000..e570090f
--- /dev/null
+++ b/docs/404.md
@@ -0,0 +1,8 @@
+---
+title: Page Not Found
+
+---
+
+# 404 - Page Not Found
+
+The page you are looking for does not exist. Please check the URL or go back to the [home page](/).
diff --git a/docs/pages/example.md b/docs/pages/example.md
new file mode 100644
index 00000000..638515f4
--- /dev/null
+++ b/docs/pages/example.md
@@ -0,0 +1,8 @@
+---
+title: Example
+
+---
+
+# Stone Packaging Example
+
+Here's an example of how to use Stone Packaging...
diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md
new file mode 100644
index 00000000..aa1eafc5
--- /dev/null
+++ b/docs/pages/getting-started.md
@@ -0,0 +1,8 @@
+---
+title: Getting Started
+
+---
+
+# Getting Started with Stone Packaging
+
+...
\ No newline at end of file
diff --git a/docs/pages/index.md b/docs/pages/index.md
new file mode 100644
index 00000000..5185b5eb
--- /dev/null
+++ b/docs/pages/index.md
@@ -0,0 +1,9 @@
+---
+title: Introduction
+---
+
+# Stone Packaging
+
+This is the main page of Stone Packaging documentation.
+
+Here's an example of how to use Stone Packaging...
\ No newline at end of file
diff --git a/package.json b/package.json
new file mode 100644
index 00000000..672e5335
--- /dev/null
+++ b/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "stone-packaging",
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vocs dev",
+    "build": "vocs build"
+  },
+  "dependencies": {
+    "vocs": "^1.0.0-alpha.61",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.9.5",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11"
+  }
+}
diff --git a/theme.config.tsx b/theme.config.tsx
new file mode 100644
index 00000000..7ca8a723
--- /dev/null
+++ b/theme.config.tsx
@@ -0,0 +1,18 @@
+import { defineConfig } from 'vocs'
+
+export default defineConfig({
+  sidebar: [
+    {
+      text: 'Getting Started',
+      link: '/getting-started',
+    },
+    {
+      text: 'Example',
+      link: '/example',
+    },
+    {
+      text: 'Resources',
+      link: '/resources',
+    },
+  ],
+})
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 00000000..efbaf236
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "moduleResolution": "node",
+    "module": "esnext",
+    "noEmit": true,
+    "lib": ["es2022", "dom", "dom.iterable"],
+    "types": ["vocs"]
+  },
+  "include": ["vocs.config.ts"]
+}
diff --git a/vocs.config.ts b/vocs.config.ts
new file mode 100644
index 00000000..d79462ca
--- /dev/null
+++ b/vocs.config.ts
@@ -0,0 +1,25 @@
+import { defineConfig } from 'vocs'
+
+export default defineConfig({
+  title: 'Stone Packaging',
+  rootDir: 'docs',
+  
+  sidebar: [
+    {
+      text: 'Introduction',
+      link: '/',
+    },
+    {
+      text: 'Getting Started',
+      link: '/getting-started',
+    },
+    {
+      text: 'Example',
+      link: '/example',
+    },
+    {
+      text: 'Stone Packaging Resources',
+      link: '/resourcers',
+    },
+  ],
+})
diff --git a/vocs.d.ts b/vocs.d.ts
new file mode 100644
index 00000000..0605aa17
--- /dev/null
+++ b/vocs.d.ts
@@ -0,0 +1,3 @@
+declare module 'vocs' {
+  export function defineConfig(config: any): any;
+}

From 39394f72249fdce12d3ccfe9a4cb4b5ab98b81e3 Mon Sep 17 00:00:00 2001
From: Nathan_akin <85641756+akintewe@users.noreply.github.com>
Date: Mon, 30 Sep 2024 13:28:28 +0100
Subject: [PATCH 2/2] added required files

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/README.md b/README.md
index 72a5214a..8a60b80e 100644
--- a/README.md
+++ b/README.md
@@ -150,3 +150,60 @@ cpu_air_verifier --in_file=fibonacci_proof.json && echo "Successfully verified e
 ```
 
 This project is supported by Nethermind and Starknet Foundation via [OnlyDust platform](https://app.onlydust.com/p/stone-packaging-)
+
+
+### USNG VOCS TO GENERATE DOCUMENTATION LOCALHOST SITE
+
+We use Vocs to generate our documentation site. Here's how to set it up and run it locally:
+
+### Prerequisites
+
+- Node.js (version 14 or later)
+- Yarn package manager
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/dipdup-io/stone-packaging.git
+   cd stone-packaging
+   ```
+
+2. Install dependencies:
+   ```bash
+   yarn install
+   ```
+
+### Running the Development Server
+
+To start the development server:
+
+```bash
+yarn dev
+```
+
+This will start the server at `http://localhost:5173`. The site will automatically reload if you make changes to the source files.
+
+### Building the Static Site
+
+To build the static site:
+
+```bash
+yarn build
+```
+
+This will generate the static files in the `dist` directory.
+
+### Project Structure
+
+- `docs/`: Contains all the documentation markdown files.
+- `docs/pages/`: Contains the main content pages.
+- `docs/index.md`: The home page of the documentation.
+- `vocs.config.ts`: Configuration file for Vocs.
+
+### Adding New Pages
+
+To add a new page to the documentation:
+
+1. Create a new markdown file in the `docs/pages/` directory.
+2. Add the new page to the sidebar in `vocs.config.ts`.